brevo-ruby 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/LICENSE.md +21 -0
- data/README.md +651 -0
- data/Rakefile +8 -0
- data/brevo-ruby.gemspec +46 -0
- data/docs/AbTestCampaignResult.md +15 -0
- data/docs/AbTestCampaignResultClickedLinks.md +9 -0
- data/docs/AbTestCampaignResultStatistics.md +13 -0
- data/docs/AbTestVersionClicks.md +7 -0
- data/docs/AbTestVersionClicksInner.md +10 -0
- data/docs/AbTestVersionStats.md +9 -0
- data/docs/AccountApi.md +125 -0
- data/docs/AddChildDomain.md +8 -0
- data/docs/AddContactToList.md +9 -0
- data/docs/AddCredits.md +9 -0
- data/docs/AuthenticateDomainModel.md +9 -0
- data/docs/BlockDomain.md +8 -0
- data/docs/Body.md +10 -0
- data/docs/Body1.md +10 -0
- data/docs/Body10.md +11 -0
- data/docs/Body11.md +8 -0
- data/docs/Body12.md +11 -0
- data/docs/Body2.md +11 -0
- data/docs/Body3.md +9 -0
- data/docs/Body4.md +9 -0
- data/docs/Body5.md +11 -0
- data/docs/Body6.md +18 -0
- data/docs/Body7.md +17 -0
- data/docs/Body8.md +13 -0
- data/docs/Body9.md +8 -0
- data/docs/BodyVariablesItems.md +7 -0
- data/docs/CompaniesApi.md +425 -0
- data/docs/CompaniesList.md +8 -0
- data/docs/Company.md +11 -0
- data/docs/CompanyAttributes.md +7 -0
- data/docs/CompanyAttributesInner.md +12 -0
- data/docs/ComponentItems.md +9 -0
- data/docs/ContactsApi.md +1767 -0
- data/docs/ConversationsApi.md +542 -0
- data/docs/ConversationsMessage.md +17 -0
- data/docs/ConversationsMessageFile.md +12 -0
- data/docs/ConversationsMessageFileImageInfo.md +10 -0
- data/docs/CouponsApi.md +305 -0
- data/docs/CreateApiKeyRequest.md +9 -0
- data/docs/CreateApiKeyResponse.md +9 -0
- data/docs/CreateAttribute.md +11 -0
- data/docs/CreateAttributeEnumeration.md +9 -0
- data/docs/CreateCategoryModel.md +8 -0
- data/docs/CreateChild.md +13 -0
- data/docs/CreateContact.md +15 -0
- data/docs/CreateCouponCollection.md +9 -0
- data/docs/CreateCoupons.md +9 -0
- data/docs/CreateDoiContact.md +13 -0
- data/docs/CreateDomain.md +8 -0
- data/docs/CreateDomainModel.md +11 -0
- data/docs/CreateDomainModelDnsRecords.md +9 -0
- data/docs/CreateDomainModelDnsRecordsDkimRecord.md +11 -0
- data/docs/CreateEmailCampaign.md +37 -0
- data/docs/CreateEmailCampaignRecipients.md +10 -0
- data/docs/CreateEmailCampaignSender.md +10 -0
- data/docs/CreateExternalFeed.md +16 -0
- data/docs/CreateList.md +9 -0
- data/docs/CreateModel.md +8 -0
- data/docs/CreateProductModel.md +8 -0
- data/docs/CreateReseller.md +9 -0
- data/docs/CreateSender.md +10 -0
- data/docs/CreateSenderIps.md +10 -0
- data/docs/CreateSenderModel.md +10 -0
- data/docs/CreateSmsCampaign.md +15 -0
- data/docs/CreateSmsCampaignRecipients.md +9 -0
- data/docs/CreateSmtpEmail.md +9 -0
- data/docs/CreateSmtpTemplate.md +17 -0
- data/docs/CreateSmtpTemplateSender.md +10 -0
- data/docs/CreateSubAccount.md +11 -0
- data/docs/CreateSubAccountResponse.md +8 -0
- data/docs/CreateUpdateBatchCategory.md +9 -0
- data/docs/CreateUpdateBatchCategoryModel.md +9 -0
- data/docs/CreateUpdateBatchProducts.md +9 -0
- data/docs/CreateUpdateBatchProductsModel.md +9 -0
- data/docs/CreateUpdateCategories.md +11 -0
- data/docs/CreateUpdateCategory.md +12 -0
- data/docs/CreateUpdateContactModel.md +8 -0
- data/docs/CreateUpdateFolder.md +8 -0
- data/docs/CreateUpdateProduct.md +18 -0
- data/docs/CreateUpdateProducts.md +17 -0
- data/docs/CreateWebhook.md +12 -0
- data/docs/CreateWhatsAppCampaign.md +11 -0
- data/docs/CreateWhatsAppCampaignRecipients.md +10 -0
- data/docs/CreateWhatsAppTemplate.md +13 -0
- data/docs/CreatedBatchId.md +8 -0
- data/docs/CreatedProcessId.md +8 -0
- data/docs/Deal.md +11 -0
- data/docs/DealAttributes.md +7 -0
- data/docs/DealAttributesInner.md +12 -0
- data/docs/DealsApi.md +536 -0
- data/docs/DealsList.md +8 -0
- data/docs/DeleteHardbounces.md +10 -0
- data/docs/DomainsApi.md +292 -0
- data/docs/EcommerceApi.md +675 -0
- data/docs/EmailCampaignsApi.md +799 -0
- data/docs/EmailExportRecipients.md +9 -0
- data/docs/ErrorModel.md +9 -0
- data/docs/ExportWebhooksHistory.md +16 -0
- data/docs/ExternalFeedsApi.md +322 -0
- data/docs/FileData.md +14 -0
- data/docs/FileDownloadableLink.md +8 -0
- data/docs/FileList.md +7 -0
- data/docs/FilesApi.md +318 -0
- data/docs/GetAccount.md +15 -0
- data/docs/GetAccountActivity.md +8 -0
- data/docs/GetAccountActivityLogs.md +12 -0
- data/docs/GetAccountMarketingAutomation.md +9 -0
- data/docs/GetAccountPlan.md +13 -0
- data/docs/GetAccountRelay.md +9 -0
- data/docs/GetAccountRelayData.md +10 -0
- data/docs/GetAggregatedReport.md +20 -0
- data/docs/GetAllExternalFeeds.md +9 -0
- data/docs/GetAllExternalFeedsFeeds.md +19 -0
- data/docs/GetAttributes.md +8 -0
- data/docs/GetAttributesAttributes.md +12 -0
- data/docs/GetAttributesEnumeration.md +9 -0
- data/docs/GetBlockedDomains.md +8 -0
- data/docs/GetCampaignOverview.md +20 -0
- data/docs/GetCampaignRecipients.md +9 -0
- data/docs/GetCampaignStats.md +23 -0
- data/docs/GetCategories.md +9 -0
- data/docs/GetCategoryDetails.md +13 -0
- data/docs/GetChildAccountCreationStatus.md +8 -0
- data/docs/GetChildDomain.md +9 -0
- data/docs/GetChildDomains.md +7 -0
- data/docs/GetChildInfo.md +16 -0
- data/docs/GetChildInfoApiKeys.md +9 -0
- data/docs/GetChildInfoApiKeysV2.md +9 -0
- data/docs/GetChildInfoApiKeysV3.md +9 -0
- data/docs/GetChildInfoCredits.md +9 -0
- data/docs/GetChildInfoStatistics.md +10 -0
- data/docs/GetChildrenList.md +9 -0
- data/docs/GetClient.md +11 -0
- data/docs/GetContactCampaignStats.md +16 -0
- data/docs/GetContactCampaignStatsClicked.md +9 -0
- data/docs/GetContactCampaignStatsOpened.md +11 -0
- data/docs/GetContactCampaignStatsTransacAttributes.md +10 -0
- data/docs/GetContactCampaignStatsUnsubscriptions.md +9 -0
- data/docs/GetContactDetails.md +16 -0
- data/docs/GetContacts.md +9 -0
- data/docs/GetCouponCollection.md +13 -0
- data/docs/GetDeviceBrowserStats.md +11 -0
- data/docs/GetDomainConfigurationModel.md +11 -0
- data/docs/GetDomainsList.md +8 -0
- data/docs/GetDomainsListDomains.md +12 -0
- data/docs/GetEmailCampaign.md +38 -0
- data/docs/GetEmailCampaigns.md +9 -0
- data/docs/GetEmailEventReport.md +8 -0
- data/docs/GetEmailEventReportEvents.md +18 -0
- data/docs/GetExtendedCampaignOverview.md +36 -0
- data/docs/GetExtendedCampaignOverviewSender.md +10 -0
- data/docs/GetExtendedCampaignStats.md +15 -0
- data/docs/GetExtendedCampaignStatsGlobalStats.md +7 -0
- data/docs/GetExtendedClient.md +12 -0
- data/docs/GetExtendedClientAddress.md +11 -0
- data/docs/GetExtendedContactDetails.md +17 -0
- data/docs/GetExtendedContactDetailsStatistics.md +16 -0
- data/docs/GetExtendedContactDetailsStatisticsClicked.md +9 -0
- data/docs/GetExtendedContactDetailsStatisticsDelivered.md +9 -0
- data/docs/GetExtendedContactDetailsStatisticsLinks.md +11 -0
- data/docs/GetExtendedContactDetailsStatisticsMessagesSent.md +9 -0
- data/docs/GetExtendedContactDetailsStatisticsOpened.md +11 -0
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptions.md +9 -0
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +9 -0
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +10 -0
- data/docs/GetExtendedList.md +16 -0
- data/docs/GetExtendedListCampaignStats.md +9 -0
- data/docs/GetExternalFeedByUUID.md +19 -0
- data/docs/GetExternalFeedByUUIDHeaders.md +9 -0
- data/docs/GetFolder.md +12 -0
- data/docs/GetFolderLists.md +9 -0
- data/docs/GetFolders.md +9 -0
- data/docs/GetInboundEmailEvents.md +8 -0
- data/docs/GetInboundEmailEventsByUuid.md +15 -0
- data/docs/GetInboundEmailEventsByUuidAttachments.md +11 -0
- data/docs/GetInboundEmailEventsByUuidLogs.md +9 -0
- data/docs/GetInboundEmailEventsEvents.md +11 -0
- data/docs/GetInvitedUsersList.md +8 -0
- data/docs/GetInvitedUsersListFeatureAccess.md +10 -0
- data/docs/GetInvitedUsersListUsers.md +11 -0
- data/docs/GetIp.md +11 -0
- data/docs/GetIpFromSender.md +11 -0
- data/docs/GetIps.md +8 -0
- data/docs/GetIpsFromSender.md +8 -0
- data/docs/GetList.md +12 -0
- data/docs/GetLists.md +9 -0
- data/docs/GetProcess.md +11 -0
- data/docs/GetProcesses.md +9 -0
- data/docs/GetProductDetails.md +22 -0
- data/docs/GetProducts.md +9 -0
- data/docs/GetReports.md +8 -0
- data/docs/GetReportsReports.md +20 -0
- data/docs/GetScheduledEmailByBatchId.md +9 -0
- data/docs/GetScheduledEmailByBatchIdBatches.md +10 -0
- data/docs/GetScheduledEmailByMessageId.md +10 -0
- data/docs/GetSegments.md +9 -0
- data/docs/GetSegmentsSegments.md +11 -0
- data/docs/GetSendersList.md +8 -0
- data/docs/GetSendersListIps.md +10 -0
- data/docs/GetSendersListSenders.md +12 -0
- data/docs/GetSharedTemplateUrl.md +8 -0
- data/docs/GetSmsCampaign.md +17 -0
- data/docs/GetSmsCampaignOverview.md +15 -0
- data/docs/GetSmsCampaignRecipients.md +7 -0
- data/docs/GetSmsCampaignStats.md +14 -0
- data/docs/GetSmsCampaigns.md +9 -0
- data/docs/GetSmsEventReport.md +8 -0
- data/docs/GetSmsEventReportEvents.md +14 -0
- data/docs/GetSmtpTemplateOverview.md +20 -0
- data/docs/GetSmtpTemplateOverviewSender.md +10 -0
- data/docs/GetSmtpTemplates.md +9 -0
- data/docs/GetSsoToken.md +8 -0
- data/docs/GetStatsByBrowser.md +7 -0
- data/docs/GetStatsByDevice.md +11 -0
- data/docs/GetStatsByDomain.md +7 -0
- data/docs/GetTransacAggregatedSmsReport.md +17 -0
- data/docs/GetTransacBlockedContacts.md +9 -0
- data/docs/GetTransacBlockedContactsContacts.md +11 -0
- data/docs/GetTransacBlockedContactsReason.md +9 -0
- data/docs/GetTransacEmailContent.md +14 -0
- data/docs/GetTransacEmailContentEvents.md +9 -0
- data/docs/GetTransacEmailsList.md +9 -0
- data/docs/GetTransacEmailsListTransactionalEmails.md +15 -0
- data/docs/GetTransacSmsReport.md +8 -0
- data/docs/GetTransacSmsReportReports.md +17 -0
- data/docs/GetUserPermission.md +10 -0
- data/docs/GetUserPermissionPrivileges.md +9 -0
- data/docs/GetWATemplates.md +9 -0
- data/docs/GetWATemplatesTemplates.md +15 -0
- data/docs/GetWebhook.md +14 -0
- data/docs/GetWebhooks.md +8 -0
- data/docs/GetWhatsAppConfig.md +13 -0
- data/docs/GetWhatsappCampaignOverview.md +16 -0
- data/docs/GetWhatsappCampaigns.md +9 -0
- data/docs/GetWhatsappCampaignsCampaigns.md +18 -0
- data/docs/GetWhatsappEventReport.md +8 -0
- data/docs/GetWhatsappEventReportEvents.md +15 -0
- data/docs/InboundParsingApi.md +199 -0
- data/docs/InlineResponse200.md +8 -0
- data/docs/InlineResponse2001.md +10 -0
- data/docs/InlineResponse201.md +8 -0
- data/docs/InlineResponse2011.md +8 -0
- data/docs/InlineResponse2012.md +8 -0
- data/docs/InlineResponse2013.md +8 -0
- data/docs/InlineResponse2014.md +8 -0
- data/docs/ManageIp.md +8 -0
- data/docs/MasterAccountApi.md +549 -0
- data/docs/MasterDetailsResponse.md +14 -0
- data/docs/MasterDetailsResponseBillingInfo.md +11 -0
- data/docs/MasterDetailsResponseBillingInfoAddress.md +12 -0
- data/docs/MasterDetailsResponseBillingInfoName.md +9 -0
- data/docs/MasterDetailsResponsePlanInfo.md +13 -0
- data/docs/MasterDetailsResponsePlanInfoFeatures.md +12 -0
- data/docs/Note.md +14 -0
- data/docs/NoteData.md +11 -0
- data/docs/NoteId.md +8 -0
- data/docs/NoteList.md +7 -0
- data/docs/NotesApi.md +312 -0
- data/docs/Order.md +16 -0
- data/docs/OrderBatch.md +9 -0
- data/docs/OrderBilling.md +14 -0
- data/docs/OrderProducts.md +11 -0
- data/docs/Otp.md +8 -0
- data/docs/Pipeline.md +10 -0
- data/docs/PipelineStage.md +9 -0
- data/docs/Pipelines.md +7 -0
- data/docs/PostContactInfo.md +8 -0
- data/docs/PostContactInfoContacts.md +11 -0
- data/docs/PostSendFailed.md +12 -0
- data/docs/PostSendSmsTestFailed.md +11 -0
- data/docs/ProcessApi.md +129 -0
- data/docs/RemainingCreditModel.md +9 -0
- data/docs/RemainingCreditModelChild.md +9 -0
- data/docs/RemainingCreditModelReseller.md +9 -0
- data/docs/RemoveContactFromList.md +10 -0
- data/docs/RemoveCredits.md +9 -0
- data/docs/RequestContactExport.md +10 -0
- data/docs/RequestContactExportCustomContactFilter.md +13 -0
- data/docs/RequestContactImport.md +17 -0
- data/docs/RequestContactImportNewList.md +9 -0
- data/docs/RequestSMSRecipientExport.md +9 -0
- data/docs/ResellerApi.md +964 -0
- data/docs/SMSCampaignsApi.md +613 -0
- data/docs/ScheduleSmtpEmail.md +10 -0
- data/docs/SendReport.md +9 -0
- data/docs/SendReportEmail.md +9 -0
- data/docs/SendSms.md +12 -0
- data/docs/SendSmtpEmail.md +23 -0
- data/docs/SendSmtpEmailAttachment.md +10 -0
- data/docs/SendSmtpEmailBcc.md +9 -0
- data/docs/SendSmtpEmailCc.md +9 -0
- data/docs/SendSmtpEmailMessageVersions.md +13 -0
- data/docs/SendSmtpEmailReplyTo.md +9 -0
- data/docs/SendSmtpEmailReplyTo1.md +9 -0
- data/docs/SendSmtpEmailSender.md +10 -0
- data/docs/SendSmtpEmailTo.md +9 -0
- data/docs/SendSmtpEmailTo1.md +9 -0
- data/docs/SendTestEmail.md +8 -0
- data/docs/SendTestSms.md +8 -0
- data/docs/SendTransacSms.md +15 -0
- data/docs/SendWhatsappMessage.md +11 -0
- data/docs/SendersApi.md +417 -0
- data/docs/SsoTokenRequest.md +10 -0
- data/docs/SubAccountDetailsResponse.md +11 -0
- data/docs/SubAccountDetailsResponsePlanInfo.md +10 -0
- data/docs/SubAccountDetailsResponsePlanInfoCredits.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoCreditsEmails.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoFeatures.md +10 -0
- data/docs/SubAccountDetailsResponsePlanInfoFeaturesInbox.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoFeaturesUsers.md +9 -0
- data/docs/SubAccountUpdatePlanRequest.md +9 -0
- data/docs/SubAccountUpdatePlanRequestCredits.md +8 -0
- data/docs/SubAccountUpdatePlanRequestFeatures.md +10 -0
- data/docs/SubAccountsResponse.md +9 -0
- data/docs/SubAccountsResponseSubAccounts.md +11 -0
- data/docs/Task.md +13 -0
- data/docs/TaskList.md +8 -0
- data/docs/TaskReminder.md +10 -0
- data/docs/TaskTypes.md +9 -0
- data/docs/TasksApi.md +376 -0
- data/docs/TransactionalEmailsApi.md +1390 -0
- data/docs/TransactionalSMSApi.md +273 -0
- data/docs/TransactionalWhatsAppApi.md +143 -0
- data/docs/UpdateAttribute.md +9 -0
- data/docs/UpdateAttributeEnumeration.md +9 -0
- data/docs/UpdateBatchContacts.md +8 -0
- data/docs/UpdateBatchContactsContacts.md +17 -0
- data/docs/UpdateBatchContactsModel.md +9 -0
- data/docs/UpdateCampaignStatus.md +8 -0
- data/docs/UpdateChild.md +12 -0
- data/docs/UpdateChildAccountStatus.md +11 -0
- data/docs/UpdateChildDomain.md +8 -0
- data/docs/UpdateContact.md +14 -0
- data/docs/UpdateCouponCollection.md +8 -0
- data/docs/UpdateEmailCampaign.md +37 -0
- data/docs/UpdateEmailCampaignRecipients.md +10 -0
- data/docs/UpdateEmailCampaignSender.md +10 -0
- data/docs/UpdateExternalFeed.md +16 -0
- data/docs/UpdateList.md +9 -0
- data/docs/UpdateSender.md +10 -0
- data/docs/UpdateSmsCampaign.md +15 -0
- data/docs/UpdateSmtpTemplate.md +17 -0
- data/docs/UpdateSmtpTemplateSender.md +10 -0
- data/docs/UpdateWebhook.md +11 -0
- data/docs/UpdateWhatsAppCampaign.md +11 -0
- data/docs/UploadImageModel.md +8 -0
- data/docs/UploadImageToGallery.md +9 -0
- data/docs/UserApi.md +118 -0
- data/docs/VariablesItems.md +10 -0
- data/docs/WebhooksApi.md +362 -0
- data/docs/WhatsAppCampaignsApi.md +543 -0
- data/docs/WhatsappCampStats.md +12 -0
- data/docs/WhatsappCampTemplate.md +18 -0
- data/lib/brevo-ruby/api/account_api.rb +145 -0
- data/lib/brevo-ruby/api/companies_api.rb +419 -0
- data/lib/brevo-ruby/api/contacts_api.rb +1735 -0
- data/lib/brevo-ruby/api/conversations_api.rb +514 -0
- data/lib/brevo-ruby/api/coupons_api.rb +316 -0
- data/lib/brevo-ruby/api/deals_api.rb +518 -0
- data/lib/brevo-ruby/api/domains_api.rb +282 -0
- data/lib/brevo-ruby/api/ecommerce_api.rb +655 -0
- data/lib/brevo-ruby/api/email_campaigns_api.rb +782 -0
- data/lib/brevo-ruby/api/external_feeds_api.rb +336 -0
- data/lib/brevo-ruby/api/files_api.rb +323 -0
- data/lib/brevo-ruby/api/inbound_parsing_api.rb +218 -0
- data/lib/brevo-ruby/api/master_account_api.rb +535 -0
- data/lib/brevo-ruby/api/notes_api.rb +318 -0
- data/lib/brevo-ruby/api/process_api.rb +151 -0
- data/lib/brevo-ruby/api/reseller_api.rb +923 -0
- data/lib/brevo-ruby/api/senders_api.rb +388 -0
- data/lib/brevo-ruby/api/sms_campaigns_api.rb +603 -0
- data/lib/brevo-ruby/api/tasks_api.rb +385 -0
- data/lib/brevo-ruby/api/transactional_emails_api.rb +1370 -0
- data/lib/brevo-ruby/api/transactional_sms_api.rb +290 -0
- data/lib/brevo-ruby/api/transactional_whats_app_api.rb +173 -0
- data/lib/brevo-ruby/api/user_api.rb +131 -0
- data/lib/brevo-ruby/api/webhooks_api.rb +357 -0
- data/lib/brevo-ruby/api/whats_app_campaigns_api.rb +534 -0
- data/lib/brevo-ruby/api_client.rb +392 -0
- data/lib/brevo-ruby/api_error.rb +38 -0
- data/lib/brevo-ruby/configuration.rb +216 -0
- data/lib/brevo-ruby/models/ab_test_campaign_result.rb +299 -0
- data/lib/brevo-ruby/models/ab_test_campaign_result_clicked_links.rb +203 -0
- data/lib/brevo-ruby/models/ab_test_campaign_result_statistics.rb +259 -0
- data/lib/brevo-ruby/models/ab_test_version_clicks.rb +176 -0
- data/lib/brevo-ruby/models/ab_test_version_clicks_inner.rb +220 -0
- data/lib/brevo-ruby/models/ab_test_version_stats.rb +206 -0
- data/lib/brevo-ruby/models/add_child_domain.rb +185 -0
- data/lib/brevo-ruby/models/add_contact_to_list.rb +199 -0
- data/lib/brevo-ruby/models/add_credits.rb +195 -0
- data/lib/brevo-ruby/models/authenticate_domain_model.rb +205 -0
- data/lib/brevo-ruby/models/block_domain.rb +190 -0
- data/lib/brevo-ruby/models/body.rb +210 -0
- data/lib/brevo-ruby/models/body_1.rb +205 -0
- data/lib/brevo-ruby/models/body_10.rb +225 -0
- data/lib/brevo-ruby/models/body_11.rb +190 -0
- data/lib/brevo-ruby/models/body_12.rb +215 -0
- data/lib/brevo-ruby/models/body_2.rb +223 -0
- data/lib/brevo-ruby/models/body_3.rb +200 -0
- data/lib/brevo-ruby/models/body_4.rb +195 -0
- data/lib/brevo-ruby/models/body_5.rb +223 -0
- data/lib/brevo-ruby/models/body_6.rb +320 -0
- data/lib/brevo-ruby/models/body_7.rb +281 -0
- data/lib/brevo-ruby/models/body_8.rb +245 -0
- data/lib/brevo-ruby/models/body_9.rb +190 -0
- data/lib/brevo-ruby/models/body_variables_items.rb +175 -0
- data/lib/brevo-ruby/models/companies_list.rb +188 -0
- data/lib/brevo-ruby/models/company.rb +220 -0
- data/lib/brevo-ruby/models/company_attributes.rb +176 -0
- data/lib/brevo-ruby/models/company_attributes_inner.rb +223 -0
- data/lib/brevo-ruby/models/component_items.rb +193 -0
- data/lib/brevo-ruby/models/conversations_message.rb +324 -0
- data/lib/brevo-ruby/models/conversations_message_file.rb +239 -0
- data/lib/brevo-ruby/models/conversations_message_file_image_info.rb +236 -0
- data/lib/brevo-ruby/models/create_api_key_request.rb +200 -0
- data/lib/brevo-ruby/models/create_api_key_response.rb +195 -0
- data/lib/brevo-ruby/models/create_attribute.rb +251 -0
- data/lib/brevo-ruby/models/create_attribute_enumeration.rb +205 -0
- data/lib/brevo-ruby/models/create_category_model.rb +185 -0
- data/lib/brevo-ruby/models/create_child.rb +294 -0
- data/lib/brevo-ruby/models/create_contact.rb +261 -0
- data/lib/brevo-ruby/models/create_coupon_collection.rb +205 -0
- data/lib/brevo-ruby/models/create_coupons.rb +206 -0
- data/lib/brevo-ruby/models/create_doi_contact.rb +259 -0
- data/lib/brevo-ruby/models/create_domain.rb +190 -0
- data/lib/brevo-ruby/models/create_domain_model.rb +219 -0
- data/lib/brevo-ruby/models/create_domain_model_dns_records.rb +193 -0
- data/lib/brevo-ruby/models/create_domain_model_dns_records_dkim_record.rb +211 -0
- data/lib/brevo-ruby/models/create_email_campaign.rb +597 -0
- data/lib/brevo-ruby/models/create_email_campaign_recipients.rb +212 -0
- data/lib/brevo-ruby/models/create_email_campaign_sender.rb +211 -0
- data/lib/brevo-ruby/models/create_external_feed.rb +339 -0
- data/lib/brevo-ruby/models/create_list.rb +205 -0
- data/lib/brevo-ruby/models/create_model.rb +190 -0
- data/lib/brevo-ruby/models/create_product_model.rb +185 -0
- data/lib/brevo-ruby/models/create_reseller.rb +200 -0
- data/lib/brevo-ruby/models/create_sender.rb +217 -0
- data/lib/brevo-ruby/models/create_sender_ips.rb +239 -0
- data/lib/brevo-ruby/models/create_sender_model.rb +210 -0
- data/lib/brevo-ruby/models/create_sms_campaign.rb +290 -0
- data/lib/brevo-ruby/models/create_sms_campaign_recipients.rb +204 -0
- data/lib/brevo-ruby/models/create_smtp_email.rb +196 -0
- data/lib/brevo-ruby/models/create_smtp_template.rb +289 -0
- data/lib/brevo-ruby/models/create_smtp_template_sender.rb +206 -0
- data/lib/brevo-ruby/models/create_sub_account.rb +259 -0
- data/lib/brevo-ruby/models/create_sub_account_response.rb +190 -0
- data/lib/brevo-ruby/models/create_update_batch_category.rb +202 -0
- data/lib/brevo-ruby/models/create_update_batch_category_model.rb +195 -0
- data/lib/brevo-ruby/models/create_update_batch_products.rb +202 -0
- data/lib/brevo-ruby/models/create_update_batch_products_model.rb +195 -0
- data/lib/brevo-ruby/models/create_update_categories.rb +220 -0
- data/lib/brevo-ruby/models/create_update_category.rb +232 -0
- data/lib/brevo-ruby/models/create_update_contact_model.rb +185 -0
- data/lib/brevo-ruby/models/create_update_folder.rb +185 -0
- data/lib/brevo-ruby/models/create_update_product.rb +301 -0
- data/lib/brevo-ruby/models/create_update_products.rb +289 -0
- data/lib/brevo-ruby/models/create_webhook.rb +273 -0
- data/lib/brevo-ruby/models/create_whats_app_campaign.rb +234 -0
- data/lib/brevo-ruby/models/create_whats_app_campaign_recipients.rb +212 -0
- data/lib/brevo-ruby/models/create_whats_app_template.rb +289 -0
- data/lib/brevo-ruby/models/created_batch_id.rb +190 -0
- data/lib/brevo-ruby/models/created_process_id.rb +190 -0
- data/lib/brevo-ruby/models/deal.rb +220 -0
- data/lib/brevo-ruby/models/deal_attributes.rb +176 -0
- data/lib/brevo-ruby/models/deal_attributes_inner.rb +223 -0
- data/lib/brevo-ruby/models/deals_list.rb +188 -0
- data/lib/brevo-ruby/models/delete_hardbounces.rb +205 -0
- data/lib/brevo-ruby/models/email_export_recipients.rb +234 -0
- data/lib/brevo-ruby/models/error_model.rb +239 -0
- data/lib/brevo-ruby/models/export_webhooks_history.rb +309 -0
- data/lib/brevo-ruby/models/file_data.rb +246 -0
- data/lib/brevo-ruby/models/file_downloadable_link.rb +190 -0
- data/lib/brevo-ruby/models/file_list.rb +176 -0
- data/lib/brevo-ruby/models/get_account.rb +289 -0
- data/lib/brevo-ruby/models/get_account_activity.rb +187 -0
- data/lib/brevo-ruby/models/get_account_activity_logs.rb +250 -0
- data/lib/brevo-ruby/models/get_account_marketing_automation.rb +200 -0
- data/lib/brevo-ruby/models/get_account_plan.rb +296 -0
- data/lib/brevo-ruby/models/get_account_relay.rb +205 -0
- data/lib/brevo-ruby/models/get_account_relay_data.rb +221 -0
- data/lib/brevo-ruby/models/get_aggregated_report.rb +305 -0
- data/lib/brevo-ruby/models/get_all_external_feeds.rb +196 -0
- data/lib/brevo-ruby/models/get_all_external_feeds_feeds.rb +404 -0
- data/lib/brevo-ruby/models/get_attributes.rb +192 -0
- data/lib/brevo-ruby/models/get_attributes_attributes.rb +283 -0
- data/lib/brevo-ruby/models/get_attributes_enumeration.rb +205 -0
- data/lib/brevo-ruby/models/get_blocked_domains.rb +193 -0
- data/lib/brevo-ruby/models/get_campaign_overview.rb +371 -0
- data/lib/brevo-ruby/models/get_campaign_recipients.rb +207 -0
- data/lib/brevo-ruby/models/get_campaign_stats.rb +390 -0
- data/lib/brevo-ruby/models/get_categories.rb +206 -0
- data/lib/brevo-ruby/models/get_category_details.rb +255 -0
- data/lib/brevo-ruby/models/get_child_account_creation_status.rb +190 -0
- data/lib/brevo-ruby/models/get_child_domain.rb +195 -0
- data/lib/brevo-ruby/models/get_child_domains.rb +175 -0
- data/lib/brevo-ruby/models/get_child_info.rb +289 -0
- data/lib/brevo-ruby/models/get_child_info_api_keys.rb +203 -0
- data/lib/brevo-ruby/models/get_child_info_api_keys_v2.rb +205 -0
- data/lib/brevo-ruby/models/get_child_info_api_keys_v3.rb +205 -0
- data/lib/brevo-ruby/models/get_child_info_credits.rb +196 -0
- data/lib/brevo-ruby/models/get_child_info_statistics.rb +206 -0
- data/lib/brevo-ruby/models/get_children_list.rb +197 -0
- data/lib/brevo-ruby/models/get_client.rb +235 -0
- data/lib/brevo-ruby/models/get_contact_campaign_stats.rb +273 -0
- data/lib/brevo-ruby/models/get_contact_campaign_stats_clicked.rb +206 -0
- data/lib/brevo-ruby/models/get_contact_campaign_stats_opened.rb +235 -0
- data/lib/brevo-ruby/models/get_contact_campaign_stats_transac_attributes.rb +220 -0
- data/lib/brevo-ruby/models/get_contact_campaign_stats_unsubscriptions.rb +209 -0
- data/lib/brevo-ruby/models/get_contact_details.rb +307 -0
- data/lib/brevo-ruby/models/get_contacts.rb +206 -0
- data/lib/brevo-ruby/models/get_coupon_collection.rb +265 -0
- data/lib/brevo-ruby/models/get_device_browser_stats.rb +235 -0
- data/lib/brevo-ruby/models/get_domain_configuration_model.rb +234 -0
- data/lib/brevo-ruby/models/get_domains_list.rb +187 -0
- data/lib/brevo-ruby/models/get_domains_list_domains.rb +245 -0
- data/lib/brevo-ruby/models/get_email_campaign.rb +598 -0
- data/lib/brevo-ruby/models/get_email_campaigns.rb +196 -0
- data/lib/brevo-ruby/models/get_email_event_report.rb +186 -0
- data/lib/brevo-ruby/models/get_email_event_report_events.rb +339 -0
- data/lib/brevo-ruby/models/get_extended_campaign_overview.rb +570 -0
- data/lib/brevo-ruby/models/get_extended_campaign_overview_sender.rb +205 -0
- data/lib/brevo-ruby/models/get_extended_campaign_stats.rb +295 -0
- data/lib/brevo-ruby/models/get_extended_campaign_stats_global_stats.rb +176 -0
- data/lib/brevo-ruby/models/get_extended_client.rb +249 -0
- data/lib/brevo-ruby/models/get_extended_client_address.rb +236 -0
- data/lib/brevo-ruby/models/get_extended_contact_details.rb +321 -0
- data/lib/brevo-ruby/models/get_extended_contact_details_statistics.rb +281 -0
- data/lib/brevo-ruby/models/get_extended_contact_details_statistics_clicked.rb +207 -0
- data/lib/brevo-ruby/models/get_extended_contact_details_statistics_delivered.rb +205 -0
- data/lib/brevo-ruby/models/get_extended_contact_details_statistics_links.rb +235 -0
- data/lib/brevo-ruby/models/get_extended_contact_details_statistics_messages_sent.rb +205 -0
- data/lib/brevo-ruby/models/get_extended_contact_details_statistics_opened.rb +235 -0
- data/lib/brevo-ruby/models/get_extended_contact_details_statistics_unsubscriptions.rb +210 -0
- data/lib/brevo-ruby/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +200 -0
- data/lib/brevo-ruby/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +215 -0
- data/lib/brevo-ruby/models/get_extended_list.rb +301 -0
- data/lib/brevo-ruby/models/get_extended_list_campaign_stats.rb +204 -0
- data/lib/brevo-ruby/models/get_external_feed_by_uuid.rb +404 -0
- data/lib/brevo-ruby/models/get_external_feed_by_uuid_headers.rb +195 -0
- data/lib/brevo-ruby/models/get_folder.rb +250 -0
- data/lib/brevo-ruby/models/get_folder_lists.rb +196 -0
- data/lib/brevo-ruby/models/get_folders.rb +196 -0
- data/lib/brevo-ruby/models/get_inbound_email_events.rb +186 -0
- data/lib/brevo-ruby/models/get_inbound_email_events_by_uuid.rb +259 -0
- data/lib/brevo-ruby/models/get_inbound_email_events_by_uuid_attachments.rb +215 -0
- data/lib/brevo-ruby/models/get_inbound_email_events_by_uuid_logs.rb +229 -0
- data/lib/brevo-ruby/models/get_inbound_email_events_events.rb +235 -0
- data/lib/brevo-ruby/models/get_invited_users_list.rb +187 -0
- data/lib/brevo-ruby/models/get_invited_users_list_feature_access.rb +206 -0
- data/lib/brevo-ruby/models/get_invited_users_list_users.rb +234 -0
- data/lib/brevo-ruby/models/get_ip.rb +235 -0
- data/lib/brevo-ruby/models/get_ip_from_sender.rb +235 -0
- data/lib/brevo-ruby/models/get_ips.rb +192 -0
- data/lib/brevo-ruby/models/get_ips_from_sender.rb +192 -0
- data/lib/brevo-ruby/models/get_list.rb +250 -0
- data/lib/brevo-ruby/models/get_lists.rb +197 -0
- data/lib/brevo-ruby/models/get_process.rb +264 -0
- data/lib/brevo-ruby/models/get_processes.rb +197 -0
- data/lib/brevo-ruby/models/get_product_details.rb +357 -0
- data/lib/brevo-ruby/models/get_products.rb +206 -0
- data/lib/brevo-ruby/models/get_reports.rb +186 -0
- data/lib/brevo-ruby/models/get_reports_reports.rb +370 -0
- data/lib/brevo-ruby/models/get_scheduled_email_by_batch_id.rb +196 -0
- data/lib/brevo-ruby/models/get_scheduled_email_by_batch_id_batches.rb +254 -0
- data/lib/brevo-ruby/models/get_scheduled_email_by_message_id.rb +254 -0
- data/lib/brevo-ruby/models/get_segments.rb +194 -0
- data/lib/brevo-ruby/models/get_segments_segments.rb +215 -0
- data/lib/brevo-ruby/models/get_senders_list.rb +187 -0
- data/lib/brevo-ruby/models/get_senders_list_ips.rb +220 -0
- data/lib/brevo-ruby/models/get_senders_list_senders.rb +247 -0
- data/lib/brevo-ruby/models/get_shared_template_url.rb +190 -0
- data/lib/brevo-ruby/models/get_sms_campaign.rb +352 -0
- data/lib/brevo-ruby/models/get_sms_campaign_overview.rb +324 -0
- data/lib/brevo-ruby/models/get_sms_campaign_recipients.rb +175 -0
- data/lib/brevo-ruby/models/get_sms_campaign_stats.rb +280 -0
- data/lib/brevo-ruby/models/get_sms_campaigns.rb +196 -0
- data/lib/brevo-ruby/models/get_sms_event_report.rb +186 -0
- data/lib/brevo-ruby/models/get_sms_event_report_events.rb +278 -0
- data/lib/brevo-ruby/models/get_smtp_template_overview.rb +364 -0
- data/lib/brevo-ruby/models/get_smtp_template_overview_sender.rb +205 -0
- data/lib/brevo-ruby/models/get_smtp_templates.rb +196 -0
- data/lib/brevo-ruby/models/get_sso_token.rb +190 -0
- data/lib/brevo-ruby/models/get_stats_by_browser.rb +175 -0
- data/lib/brevo-ruby/models/get_stats_by_device.rb +223 -0
- data/lib/brevo-ruby/models/get_stats_by_domain.rb +175 -0
- data/lib/brevo-ruby/models/get_transac_aggregated_sms_report.rb +275 -0
- data/lib/brevo-ruby/models/get_transac_blocked_contacts.rb +196 -0
- data/lib/brevo-ruby/models/get_transac_blocked_contacts_contacts.rb +234 -0
- data/lib/brevo-ruby/models/get_transac_blocked_contacts_reason.rb +230 -0
- data/lib/brevo-ruby/models/get_transac_email_content.rb +277 -0
- data/lib/brevo-ruby/models/get_transac_email_content_events.rb +205 -0
- data/lib/brevo-ruby/models/get_transac_emails_list.rb +196 -0
- data/lib/brevo-ruby/models/get_transac_emails_list_transactional_emails.rb +282 -0
- data/lib/brevo-ruby/models/get_transac_sms_report.rb +186 -0
- data/lib/brevo-ruby/models/get_transac_sms_report_reports.rb +275 -0
- data/lib/brevo-ruby/models/get_user_permission.rb +223 -0
- data/lib/brevo-ruby/models/get_user_permission_privileges.rb +205 -0
- data/lib/brevo-ruby/models/get_wa_templates.rb +206 -0
- data/lib/brevo-ruby/models/get_wa_templates_templates.rb +290 -0
- data/lib/brevo-ruby/models/get_webhook.rb +315 -0
- data/lib/brevo-ruby/models/get_webhooks.rb +191 -0
- data/lib/brevo-ruby/models/get_whats_app_config.rb +281 -0
- data/lib/brevo-ruby/models/get_whatsapp_campaign_overview.rb +332 -0
- data/lib/brevo-ruby/models/get_whatsapp_campaigns.rb +196 -0
- data/lib/brevo-ruby/models/get_whatsapp_campaigns_campaigns.rb +353 -0
- data/lib/brevo-ruby/models/get_whatsapp_event_report.rb +186 -0
- data/lib/brevo-ruby/models/get_whatsapp_event_report_events.rb +314 -0
- data/lib/brevo-ruby/models/inline_response_200.rb +191 -0
- data/lib/brevo-ruby/models/inline_response_200_1.rb +220 -0
- data/lib/brevo-ruby/models/inline_response_201.rb +191 -0
- data/lib/brevo-ruby/models/inline_response_201_1.rb +191 -0
- data/lib/brevo-ruby/models/inline_response_201_2.rb +190 -0
- data/lib/brevo-ruby/models/inline_response_201_3.rb +190 -0
- data/lib/brevo-ruby/models/inline_response_201_4.rb +190 -0
- data/lib/brevo-ruby/models/manage_ip.rb +185 -0
- data/lib/brevo-ruby/models/master_details_response.rb +243 -0
- data/lib/brevo-ruby/models/master_details_response_billing_info.rb +214 -0
- data/lib/brevo-ruby/models/master_details_response_billing_info_address.rb +226 -0
- data/lib/brevo-ruby/models/master_details_response_billing_info_name.rb +196 -0
- data/lib/brevo-ruby/models/master_details_response_plan_info.rb +272 -0
- data/lib/brevo-ruby/models/master_details_response_plan_info_features.rb +225 -0
- data/lib/brevo-ruby/models/note.rb +283 -0
- data/lib/brevo-ruby/models/note_data.rb +255 -0
- data/lib/brevo-ruby/models/note_id.rb +186 -0
- data/lib/brevo-ruby/models/note_list.rb +176 -0
- data/lib/brevo-ruby/models/order.rb +297 -0
- data/lib/brevo-ruby/models/order_batch.rb +202 -0
- data/lib/brevo-ruby/models/order_billing.rb +246 -0
- data/lib/brevo-ruby/models/order_products.rb +231 -0
- data/lib/brevo-ruby/models/otp.rb +185 -0
- data/lib/brevo-ruby/models/pipeline.rb +208 -0
- data/lib/brevo-ruby/models/pipeline_stage.rb +196 -0
- data/lib/brevo-ruby/models/pipelines.rb +176 -0
- data/lib/brevo-ruby/models/post_contact_info.rb +189 -0
- data/lib/brevo-ruby/models/post_contact_info_contacts.rb +217 -0
- data/lib/brevo-ruby/models/post_send_failed.rb +238 -0
- data/lib/brevo-ruby/models/post_send_sms_test_failed.rb +227 -0
- data/lib/brevo-ruby/models/remaining_credit_model.rb +203 -0
- data/lib/brevo-ruby/models/remaining_credit_model_child.rb +206 -0
- data/lib/brevo-ruby/models/remaining_credit_model_reseller.rb +205 -0
- data/lib/brevo-ruby/models/remove_contact_from_list.rb +209 -0
- data/lib/brevo-ruby/models/remove_credits.rb +195 -0
- data/lib/brevo-ruby/models/request_contact_export.rb +211 -0
- data/lib/brevo-ruby/models/request_contact_export_custom_contact_filter.rb +294 -0
- data/lib/brevo-ruby/models/request_contact_import.rb +286 -0
- data/lib/brevo-ruby/models/request_contact_import_new_list.rb +196 -0
- data/lib/brevo-ruby/models/request_sms_recipient_export.rb +234 -0
- data/lib/brevo-ruby/models/schedule_smtp_email.rb +206 -0
- data/lib/brevo-ruby/models/send_report.rb +235 -0
- data/lib/brevo-ruby/models/send_report_email.rb +208 -0
- data/lib/brevo-ruby/models/send_sms.rb +233 -0
- data/lib/brevo-ruby/models/send_smtp_email.rb +345 -0
- data/lib/brevo-ruby/models/send_smtp_email_attachment.rb +220 -0
- data/lib/brevo-ruby/models/send_smtp_email_bcc.rb +200 -0
- data/lib/brevo-ruby/models/send_smtp_email_cc.rb +200 -0
- data/lib/brevo-ruby/models/send_smtp_email_message_versions.rb +247 -0
- data/lib/brevo-ruby/models/send_smtp_email_reply_to.rb +201 -0
- data/lib/brevo-ruby/models/send_smtp_email_reply_to_1.rb +201 -0
- data/lib/brevo-ruby/models/send_smtp_email_sender.rb +206 -0
- data/lib/brevo-ruby/models/send_smtp_email_to.rb +200 -0
- data/lib/brevo-ruby/models/send_smtp_email_to_1.rb +200 -0
- data/lib/brevo-ruby/models/send_test_email.rb +187 -0
- data/lib/brevo-ruby/models/send_test_sms.rb +185 -0
- data/lib/brevo-ruby/models/send_transac_sms.rb +327 -0
- data/lib/brevo-ruby/models/send_whatsapp_message.rb +227 -0
- data/lib/brevo-ruby/models/sso_token_request.rb +244 -0
- data/lib/brevo-ruby/models/sub_account_details_response.rb +214 -0
- data/lib/brevo-ruby/models/sub_account_details_response_plan_info.rb +204 -0
- data/lib/brevo-ruby/models/sub_account_details_response_plan_info_credits.rb +195 -0
- data/lib/brevo-ruby/models/sub_account_details_response_plan_info_credits_emails.rb +196 -0
- data/lib/brevo-ruby/models/sub_account_details_response_plan_info_features.rb +203 -0
- data/lib/brevo-ruby/models/sub_account_details_response_plan_info_features_inbox.rb +196 -0
- data/lib/brevo-ruby/models/sub_account_details_response_plan_info_features_landing_page.rb +196 -0
- data/lib/brevo-ruby/models/sub_account_details_response_plan_info_features_users.rb +196 -0
- data/lib/brevo-ruby/models/sub_account_update_plan_request.rb +194 -0
- data/lib/brevo-ruby/models/sub_account_update_plan_request_credits.rb +186 -0
- data/lib/brevo-ruby/models/sub_account_update_plan_request_features.rb +206 -0
- data/lib/brevo-ruby/models/sub_accounts_response.rb +196 -0
- data/lib/brevo-ruby/models/sub_accounts_response_sub_accounts.rb +235 -0
- data/lib/brevo-ruby/models/task.rb +252 -0
- data/lib/brevo-ruby/models/task_list.rb +188 -0
- data/lib/brevo-ruby/models/task_reminder.rb +257 -0
- data/lib/brevo-ruby/models/task_types.rb +196 -0
- data/lib/brevo-ruby/models/update_attribute.rb +197 -0
- data/lib/brevo-ruby/models/update_attribute_enumeration.rb +205 -0
- data/lib/brevo-ruby/models/update_batch_contacts.rb +187 -0
- data/lib/brevo-ruby/models/update_batch_contacts_contacts.rb +283 -0
- data/lib/brevo-ruby/models/update_batch_contacts_model.rb +197 -0
- data/lib/brevo-ruby/models/update_campaign_status.rb +220 -0
- data/lib/brevo-ruby/models/update_child.rb +225 -0
- data/lib/brevo-ruby/models/update_child_account_status.rb +215 -0
- data/lib/brevo-ruby/models/update_child_domain.rb +185 -0
- data/lib/brevo-ruby/models/update_contact.rb +251 -0
- data/lib/brevo-ruby/models/update_coupon_collection.rb +190 -0
- data/lib/brevo-ruby/models/update_email_campaign.rb +587 -0
- data/lib/brevo-ruby/models/update_email_campaign_recipients.rb +212 -0
- data/lib/brevo-ruby/models/update_email_campaign_sender.rb +206 -0
- data/lib/brevo-ruby/models/update_external_feed.rb +327 -0
- data/lib/brevo-ruby/models/update_list.rb +195 -0
- data/lib/brevo-ruby/models/update_sender.rb +207 -0
- data/lib/brevo-ruby/models/update_sms_campaign.rb +271 -0
- data/lib/brevo-ruby/models/update_smtp_template.rb +274 -0
- data/lib/brevo-ruby/models/update_smtp_template_sender.rb +206 -0
- data/lib/brevo-ruby/models/update_webhook.rb +239 -0
- data/lib/brevo-ruby/models/update_whats_app_campaign.rb +250 -0
- data/lib/brevo-ruby/models/upload_image_model.rb +190 -0
- data/lib/brevo-ruby/models/upload_image_to_gallery.rb +200 -0
- data/lib/brevo-ruby/models/variables_items.rb +202 -0
- data/lib/brevo-ruby/models/whatsapp_camp_stats.rb +245 -0
- data/lib/brevo-ruby/models/whatsapp_camp_template.rb +287 -0
- data/lib/brevo-ruby/version.rb +15 -0
- data/lib/brevo-ruby.rb +393 -0
- data/spec/api/account_api_spec.rb +59 -0
- data/spec/api/companies_api_spec.rb +119 -0
- data/spec/api/contacts_api_spec.rb +387 -0
- data/spec/api/conversations_api_spec.rb +140 -0
- data/spec/api/coupons_api_spec.rb +93 -0
- data/spec/api/deals_api_spec.rb +141 -0
- data/spec/api/domains_api_spec.rb +89 -0
- data/spec/api/ecommerce_api_spec.rb +173 -0
- data/spec/api/email_campaigns_api_spec.rb +195 -0
- data/spec/api/external_feeds_api_spec.rb +102 -0
- data/spec/api/files_api_spec.rb +99 -0
- data/spec/api/inbound_parsing_api_spec.rb +76 -0
- data/spec/api/master_account_api_spec.rb +145 -0
- data/spec/api/notes_api_spec.rb +97 -0
- data/spec/api/process_api_spec.rb +59 -0
- data/spec/api/reseller_api_spec.rb +223 -0
- data/spec/api/senders_api_spec.rb +114 -0
- data/spec/api/sms_campaigns_api_spec.rb +157 -0
- data/spec/api/tasks_api_spec.rb +113 -0
- data/spec/api/transactional_emails_api_spec.rb +330 -0
- data/spec/api/transactional_sms_api_spec.rb +94 -0
- data/spec/api/transactional_whats_app_api_spec.rb +66 -0
- data/spec/api/user_api_spec.rb +56 -0
- data/spec/api/webhooks_api_spec.rb +104 -0
- data/spec/api/whats_app_campaigns_api_spec.rb +142 -0
- data/spec/api_client_spec.rb +243 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/ab_test_campaign_result_clicked_links_spec.rb +47 -0
- data/spec/models/ab_test_campaign_result_spec.rb +91 -0
- data/spec/models/ab_test_campaign_result_statistics_spec.rb +71 -0
- data/spec/models/ab_test_version_clicks_inner_spec.rb +53 -0
- data/spec/models/ab_test_version_clicks_spec.rb +35 -0
- data/spec/models/ab_test_version_stats_spec.rb +47 -0
- data/spec/models/add_child_domain_spec.rb +41 -0
- data/spec/models/add_contact_to_list_spec.rb +47 -0
- data/spec/models/add_credits_spec.rb +47 -0
- data/spec/models/authenticate_domain_model_spec.rb +47 -0
- data/spec/models/block_domain_spec.rb +41 -0
- data/spec/models/body_10_spec.rb +59 -0
- data/spec/models/body_11_spec.rb +41 -0
- data/spec/models/body_12_spec.rb +59 -0
- data/spec/models/body_1_spec.rb +53 -0
- data/spec/models/body_2_spec.rb +59 -0
- data/spec/models/body_3_spec.rb +47 -0
- data/spec/models/body_4_spec.rb +47 -0
- data/spec/models/body_5_spec.rb +59 -0
- data/spec/models/body_6_spec.rb +101 -0
- data/spec/models/body_7_spec.rb +95 -0
- data/spec/models/body_8_spec.rb +71 -0
- data/spec/models/body_9_spec.rb +41 -0
- data/spec/models/body_spec.rb +53 -0
- data/spec/models/body_variables_items_spec.rb +35 -0
- data/spec/models/companies_list_spec.rb +41 -0
- data/spec/models/company_attributes_inner_spec.rb +65 -0
- data/spec/models/company_attributes_spec.rb +35 -0
- data/spec/models/company_spec.rb +59 -0
- data/spec/models/component_items_spec.rb +47 -0
- data/spec/models/conversations_message_file_image_info_spec.rb +53 -0
- data/spec/models/conversations_message_file_spec.rb +65 -0
- data/spec/models/conversations_message_spec.rb +99 -0
- data/spec/models/create_api_key_request_spec.rb +47 -0
- data/spec/models/create_api_key_response_spec.rb +47 -0
- data/spec/models/create_attribute_enumeration_spec.rb +47 -0
- data/spec/models/create_attribute_spec.rb +63 -0
- data/spec/models/create_category_model_spec.rb +41 -0
- data/spec/models/create_child_spec.rb +75 -0
- data/spec/models/create_contact_spec.rb +83 -0
- data/spec/models/create_coupon_collection_spec.rb +47 -0
- data/spec/models/create_coupons_spec.rb +47 -0
- data/spec/models/create_doi_contact_spec.rb +71 -0
- data/spec/models/create_domain_model_dns_records_dkim_record_spec.rb +59 -0
- data/spec/models/create_domain_model_dns_records_spec.rb +47 -0
- data/spec/models/create_domain_model_spec.rb +59 -0
- data/spec/models/create_domain_spec.rb +41 -0
- data/spec/models/create_email_campaign_recipients_spec.rb +53 -0
- data/spec/models/create_email_campaign_sender_spec.rb +53 -0
- data/spec/models/create_email_campaign_spec.rb +219 -0
- data/spec/models/create_external_feed_spec.rb +93 -0
- data/spec/models/create_list_spec.rb +47 -0
- data/spec/models/create_model_spec.rb +41 -0
- data/spec/models/create_product_model_spec.rb +41 -0
- data/spec/models/create_reseller_spec.rb +47 -0
- data/spec/models/create_sender_ips_spec.rb +53 -0
- data/spec/models/create_sender_model_spec.rb +53 -0
- data/spec/models/create_sender_spec.rb +53 -0
- data/spec/models/create_sms_campaign_recipients_spec.rb +47 -0
- data/spec/models/create_sms_campaign_spec.rb +83 -0
- data/spec/models/create_smtp_email_spec.rb +47 -0
- data/spec/models/create_smtp_template_sender_spec.rb +53 -0
- data/spec/models/create_smtp_template_spec.rb +95 -0
- data/spec/models/create_sub_account_response_spec.rb +41 -0
- data/spec/models/create_sub_account_spec.rb +63 -0
- data/spec/models/create_update_batch_category_model_spec.rb +47 -0
- data/spec/models/create_update_batch_category_spec.rb +47 -0
- data/spec/models/create_update_batch_products_model_spec.rb +47 -0
- data/spec/models/create_update_batch_products_spec.rb +47 -0
- data/spec/models/create_update_categories_spec.rb +59 -0
- data/spec/models/create_update_category_spec.rb +65 -0
- data/spec/models/create_update_contact_model_spec.rb +41 -0
- data/spec/models/create_update_folder_spec.rb +41 -0
- data/spec/models/create_update_product_spec.rb +101 -0
- data/spec/models/create_update_products_spec.rb +95 -0
- data/spec/models/create_webhook_spec.rb +73 -0
- data/spec/models/create_whats_app_campaign_recipients_spec.rb +53 -0
- data/spec/models/create_whats_app_campaign_spec.rb +59 -0
- data/spec/models/create_whats_app_template_spec.rb +75 -0
- data/spec/models/created_batch_id_spec.rb +41 -0
- data/spec/models/created_process_id_spec.rb +41 -0
- data/spec/models/deal_attributes_inner_spec.rb +65 -0
- data/spec/models/deal_attributes_spec.rb +35 -0
- data/spec/models/deal_spec.rb +59 -0
- data/spec/models/deals_list_spec.rb +41 -0
- data/spec/models/delete_hardbounces_spec.rb +53 -0
- data/spec/models/email_export_recipients_spec.rb +51 -0
- data/spec/models/error_model_spec.rb +51 -0
- data/spec/models/export_webhooks_history_spec.rb +93 -0
- data/spec/models/file_data_spec.rb +77 -0
- data/spec/models/file_downloadable_link_spec.rb +41 -0
- data/spec/models/file_list_spec.rb +35 -0
- data/spec/models/get_account_activity_logs_spec.rb +65 -0
- data/spec/models/get_account_activity_spec.rb +41 -0
- data/spec/models/get_account_marketing_automation_spec.rb +47 -0
- data/spec/models/get_account_plan_spec.rb +79 -0
- data/spec/models/get_account_relay_data_spec.rb +53 -0
- data/spec/models/get_account_relay_spec.rb +47 -0
- data/spec/models/get_account_spec.rb +83 -0
- data/spec/models/get_aggregated_report_spec.rb +113 -0
- data/spec/models/get_all_external_feeds_feeds_spec.rb +111 -0
- data/spec/models/get_all_external_feeds_spec.rb +47 -0
- data/spec/models/get_attributes_attributes_spec.rb +73 -0
- data/spec/models/get_attributes_enumeration_spec.rb +47 -0
- data/spec/models/get_attributes_spec.rb +41 -0
- data/spec/models/get_blocked_domains_spec.rb +41 -0
- data/spec/models/get_campaign_overview_spec.rb +121 -0
- data/spec/models/get_campaign_recipients_spec.rb +47 -0
- data/spec/models/get_campaign_stats_spec.rb +131 -0
- data/spec/models/get_categories_spec.rb +47 -0
- data/spec/models/get_category_details_spec.rb +71 -0
- data/spec/models/get_child_account_creation_status_spec.rb +41 -0
- data/spec/models/get_child_domain_spec.rb +47 -0
- data/spec/models/get_child_domains_spec.rb +35 -0
- data/spec/models/get_child_info_api_keys_spec.rb +47 -0
- data/spec/models/get_child_info_api_keys_v2_spec.rb +47 -0
- data/spec/models/get_child_info_api_keys_v3_spec.rb +47 -0
- data/spec/models/get_child_info_credits_spec.rb +47 -0
- data/spec/models/get_child_info_spec.rb +89 -0
- data/spec/models/get_child_info_statistics_spec.rb +53 -0
- data/spec/models/get_children_list_spec.rb +47 -0
- data/spec/models/get_client_spec.rb +59 -0
- data/spec/models/get_contact_campaign_stats_clicked_spec.rb +47 -0
- data/spec/models/get_contact_campaign_stats_opened_spec.rb +59 -0
- data/spec/models/get_contact_campaign_stats_spec.rb +89 -0
- data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +53 -0
- data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +47 -0
- data/spec/models/get_contact_details_spec.rb +89 -0
- data/spec/models/get_contacts_spec.rb +47 -0
- data/spec/models/get_coupon_collection_spec.rb +71 -0
- data/spec/models/get_device_browser_stats_spec.rb +59 -0
- data/spec/models/get_domain_configuration_model_spec.rb +59 -0
- data/spec/models/get_domains_list_domains_spec.rb +65 -0
- data/spec/models/get_domains_list_spec.rb +41 -0
- data/spec/models/get_email_campaign_spec.rb +229 -0
- data/spec/models/get_email_campaigns_spec.rb +47 -0
- data/spec/models/get_email_event_report_events_spec.rb +105 -0
- data/spec/models/get_email_event_report_spec.rb +41 -0
- data/spec/models/get_extended_campaign_overview_sender_spec.rb +53 -0
- data/spec/models/get_extended_campaign_overview_spec.rb +217 -0
- data/spec/models/get_extended_campaign_stats_global_stats_spec.rb +35 -0
- data/spec/models/get_extended_campaign_stats_spec.rb +83 -0
- data/spec/models/get_extended_client_address_spec.rb +59 -0
- data/spec/models/get_extended_client_spec.rb +65 -0
- data/spec/models/get_extended_contact_details_spec.rb +95 -0
- data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +47 -0
- data/spec/models/get_extended_contact_details_statistics_delivered_spec.rb +47 -0
- data/spec/models/get_extended_contact_details_statistics_links_spec.rb +59 -0
- data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +47 -0
- data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +59 -0
- data/spec/models/get_extended_contact_details_statistics_spec.rb +89 -0
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +47 -0
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +47 -0
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +53 -0
- data/spec/models/get_extended_list_campaign_stats_spec.rb +47 -0
- data/spec/models/get_extended_list_spec.rb +89 -0
- data/spec/models/get_external_feed_by_uuid_headers_spec.rb +47 -0
- data/spec/models/get_external_feed_by_uuid_spec.rb +111 -0
- data/spec/models/get_folder_lists_spec.rb +47 -0
- data/spec/models/get_folder_spec.rb +65 -0
- data/spec/models/get_folders_spec.rb +47 -0
- data/spec/models/get_inbound_email_events_by_uuid_attachments_spec.rb +59 -0
- data/spec/models/get_inbound_email_events_by_uuid_logs_spec.rb +51 -0
- data/spec/models/get_inbound_email_events_by_uuid_spec.rb +83 -0
- data/spec/models/get_inbound_email_events_events_spec.rb +59 -0
- data/spec/models/get_inbound_email_events_spec.rb +41 -0
- data/spec/models/get_invited_users_list_feature_access_spec.rb +53 -0
- data/spec/models/get_invited_users_list_spec.rb +41 -0
- data/spec/models/get_invited_users_list_users_spec.rb +59 -0
- data/spec/models/get_ip_from_sender_spec.rb +59 -0
- data/spec/models/get_ip_spec.rb +59 -0
- data/spec/models/get_ips_from_sender_spec.rb +41 -0
- data/spec/models/get_ips_spec.rb +41 -0
- data/spec/models/get_list_spec.rb +65 -0
- data/spec/models/get_lists_spec.rb +47 -0
- data/spec/models/get_process_spec.rb +63 -0
- data/spec/models/get_processes_spec.rb +47 -0
- data/spec/models/get_product_details_spec.rb +125 -0
- data/spec/models/get_products_spec.rb +47 -0
- data/spec/models/get_reports_reports_spec.rb +113 -0
- data/spec/models/get_reports_spec.rb +41 -0
- data/spec/models/get_scheduled_email_by_batch_id_batches_spec.rb +57 -0
- data/spec/models/get_scheduled_email_by_batch_id_spec.rb +47 -0
- data/spec/models/get_scheduled_email_by_message_id_spec.rb +57 -0
- data/spec/models/get_segments_segments_spec.rb +59 -0
- data/spec/models/get_segments_spec.rb +47 -0
- data/spec/models/get_senders_list_ips_spec.rb +53 -0
- data/spec/models/get_senders_list_senders_spec.rb +65 -0
- data/spec/models/get_senders_list_spec.rb +41 -0
- data/spec/models/get_shared_template_url_spec.rb +41 -0
- data/spec/models/get_sms_campaign_overview_spec.rb +87 -0
- data/spec/models/get_sms_campaign_recipients_spec.rb +35 -0
- data/spec/models/get_sms_campaign_spec.rb +99 -0
- data/spec/models/get_sms_campaign_stats_spec.rb +77 -0
- data/spec/models/get_sms_campaigns_spec.rb +47 -0
- data/spec/models/get_sms_event_report_events_spec.rb +81 -0
- data/spec/models/get_sms_event_report_spec.rb +41 -0
- data/spec/models/get_smtp_template_overview_sender_spec.rb +53 -0
- data/spec/models/get_smtp_template_overview_spec.rb +113 -0
- data/spec/models/get_smtp_templates_spec.rb +47 -0
- data/spec/models/get_sso_token_spec.rb +41 -0
- data/spec/models/get_stats_by_browser_spec.rb +35 -0
- data/spec/models/get_stats_by_device_spec.rb +59 -0
- data/spec/models/get_stats_by_domain_spec.rb +35 -0
- data/spec/models/get_transac_aggregated_sms_report_spec.rb +95 -0
- data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +59 -0
- data/spec/models/get_transac_blocked_contacts_reason_spec.rb +51 -0
- data/spec/models/get_transac_blocked_contacts_spec.rb +47 -0
- data/spec/models/get_transac_email_content_events_spec.rb +47 -0
- data/spec/models/get_transac_email_content_spec.rb +77 -0
- data/spec/models/get_transac_emails_list_spec.rb +47 -0
- data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +83 -0
- data/spec/models/get_transac_sms_report_reports_spec.rb +95 -0
- data/spec/models/get_transac_sms_report_spec.rb +41 -0
- data/spec/models/get_user_permission_privileges_spec.rb +47 -0
- data/spec/models/get_user_permission_spec.rb +53 -0
- data/spec/models/get_wa_templates_spec.rb +47 -0
- data/spec/models/get_wa_templates_templates_spec.rb +83 -0
- data/spec/models/get_webhook_spec.rb +81 -0
- data/spec/models/get_webhooks_spec.rb +41 -0
- data/spec/models/get_whats_app_config_spec.rb +79 -0
- data/spec/models/get_whatsapp_campaign_overview_spec.rb +93 -0
- data/spec/models/get_whatsapp_campaigns_campaigns_spec.rb +105 -0
- data/spec/models/get_whatsapp_campaigns_spec.rb +47 -0
- data/spec/models/get_whatsapp_event_report_events_spec.rb +87 -0
- data/spec/models/get_whatsapp_event_report_spec.rb +41 -0
- data/spec/models/inline_response_200_1_spec.rb +53 -0
- data/spec/models/inline_response_200_spec.rb +41 -0
- data/spec/models/inline_response_201_1_spec.rb +41 -0
- data/spec/models/inline_response_201_2_spec.rb +41 -0
- data/spec/models/inline_response_201_3_spec.rb +41 -0
- data/spec/models/inline_response_201_4_spec.rb +41 -0
- data/spec/models/inline_response_201_spec.rb +41 -0
- data/spec/models/manage_ip_spec.rb +41 -0
- data/spec/models/master_details_response_billing_info_address_spec.rb +65 -0
- data/spec/models/master_details_response_billing_info_name_spec.rb +47 -0
- data/spec/models/master_details_response_billing_info_spec.rb +59 -0
- data/spec/models/master_details_response_plan_info_features_spec.rb +65 -0
- data/spec/models/master_details_response_plan_info_spec.rb +75 -0
- data/spec/models/master_details_response_spec.rb +77 -0
- data/spec/models/note_data_spec.rb +59 -0
- data/spec/models/note_id_spec.rb +41 -0
- data/spec/models/note_list_spec.rb +35 -0
- data/spec/models/note_spec.rb +77 -0
- data/spec/models/order_batch_spec.rb +47 -0
- data/spec/models/order_billing_spec.rb +77 -0
- data/spec/models/order_products_spec.rb +59 -0
- data/spec/models/order_spec.rb +89 -0
- data/spec/models/otp_spec.rb +41 -0
- data/spec/models/pipeline_spec.rb +53 -0
- data/spec/models/pipeline_stage_spec.rb +47 -0
- data/spec/models/pipelines_spec.rb +35 -0
- data/spec/models/post_contact_info_contacts_spec.rb +59 -0
- data/spec/models/post_contact_info_spec.rb +41 -0
- data/spec/models/post_send_failed_spec.rb +65 -0
- data/spec/models/post_send_sms_test_failed_spec.rb +59 -0
- data/spec/models/remaining_credit_model_child_spec.rb +47 -0
- data/spec/models/remaining_credit_model_reseller_spec.rb +47 -0
- data/spec/models/remaining_credit_model_spec.rb +47 -0
- data/spec/models/remove_contact_from_list_spec.rb +53 -0
- data/spec/models/remove_credits_spec.rb +47 -0
- data/spec/models/request_contact_export_custom_contact_filter_spec.rb +83 -0
- data/spec/models/request_contact_export_spec.rb +53 -0
- data/spec/models/request_contact_import_new_list_spec.rb +47 -0
- data/spec/models/request_contact_import_spec.rb +95 -0
- data/spec/models/request_sms_recipient_export_spec.rb +51 -0
- data/spec/models/schedule_smtp_email_spec.rb +53 -0
- data/spec/models/send_report_email_spec.rb +47 -0
- data/spec/models/send_report_spec.rb +51 -0
- data/spec/models/send_sms_spec.rb +65 -0
- data/spec/models/send_smtp_email_attachment_spec.rb +53 -0
- data/spec/models/send_smtp_email_bcc_spec.rb +47 -0
- data/spec/models/send_smtp_email_cc_spec.rb +47 -0
- data/spec/models/send_smtp_email_message_versions_spec.rb +71 -0
- data/spec/models/send_smtp_email_reply_to_1_spec.rb +47 -0
- data/spec/models/send_smtp_email_reply_to_spec.rb +47 -0
- data/spec/models/send_smtp_email_sender_spec.rb +53 -0
- data/spec/models/send_smtp_email_spec.rb +131 -0
- data/spec/models/send_smtp_email_to_1_spec.rb +47 -0
- data/spec/models/send_smtp_email_to_spec.rb +47 -0
- data/spec/models/send_test_email_spec.rb +41 -0
- data/spec/models/send_test_sms_spec.rb +41 -0
- data/spec/models/send_transac_sms_spec.rb +87 -0
- data/spec/models/send_whatsapp_message_spec.rb +59 -0
- data/spec/models/sso_token_request_spec.rb +57 -0
- data/spec/models/sub_account_details_response_plan_info_credits_emails_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_credits_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_features_inbox_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_features_landing_page_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_features_spec.rb +53 -0
- data/spec/models/sub_account_details_response_plan_info_features_users_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_spec.rb +53 -0
- data/spec/models/sub_account_details_response_spec.rb +59 -0
- data/spec/models/sub_account_update_plan_request_credits_spec.rb +41 -0
- data/spec/models/sub_account_update_plan_request_features_spec.rb +53 -0
- data/spec/models/sub_account_update_plan_request_spec.rb +47 -0
- data/spec/models/sub_accounts_response_spec.rb +47 -0
- data/spec/models/sub_accounts_response_sub_accounts_spec.rb +59 -0
- data/spec/models/task_list_spec.rb +41 -0
- data/spec/models/task_reminder_spec.rb +57 -0
- data/spec/models/task_spec.rb +71 -0
- data/spec/models/task_types_spec.rb +47 -0
- data/spec/models/update_attribute_enumeration_spec.rb +47 -0
- data/spec/models/update_attribute_spec.rb +47 -0
- data/spec/models/update_batch_contacts_contacts_spec.rb +95 -0
- data/spec/models/update_batch_contacts_model_spec.rb +47 -0
- data/spec/models/update_batch_contacts_spec.rb +41 -0
- data/spec/models/update_campaign_status_spec.rb +45 -0
- data/spec/models/update_child_account_status_spec.rb +59 -0
- data/spec/models/update_child_domain_spec.rb +41 -0
- data/spec/models/update_child_spec.rb +65 -0
- data/spec/models/update_contact_spec.rb +77 -0
- data/spec/models/update_coupon_collection_spec.rb +41 -0
- data/spec/models/update_email_campaign_recipients_spec.rb +53 -0
- data/spec/models/update_email_campaign_sender_spec.rb +53 -0
- data/spec/models/update_email_campaign_spec.rb +219 -0
- data/spec/models/update_external_feed_spec.rb +93 -0
- data/spec/models/update_list_spec.rb +47 -0
- data/spec/models/update_sender_spec.rb +53 -0
- data/spec/models/update_sms_campaign_spec.rb +83 -0
- data/spec/models/update_smtp_template_sender_spec.rb +53 -0
- data/spec/models/update_smtp_template_spec.rb +95 -0
- data/spec/models/update_webhook_spec.rb +63 -0
- data/spec/models/update_whats_app_campaign_spec.rb +63 -0
- data/spec/models/upload_image_model_spec.rb +41 -0
- data/spec/models/upload_image_to_gallery_spec.rb +47 -0
- data/spec/models/variables_items_spec.rb +53 -0
- data/spec/models/whatsapp_camp_stats_spec.rb +65 -0
- data/spec/models/whatsapp_camp_template_spec.rb +101 -0
- data/spec/spec_helper.rb +111 -0
- metadata +1675 -0
|
@@ -0,0 +1,290 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Brevo API
|
|
3
|
+
|
|
4
|
+
#Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/getbrevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
|
5
|
+
|
|
6
|
+
OpenAPI spec version: 3.0.0
|
|
7
|
+
Contact: contact@brevo.com
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
+
Swagger Codegen version: 2.4.19
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'uri'
|
|
14
|
+
|
|
15
|
+
module BrevoRuby
|
|
16
|
+
class TransactionalSMSApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
# Set custom user_agent if explicitly passed in api
|
|
24
|
+
# default will still remain Swagger-Codegen/#{VERSION}/ruby
|
|
25
|
+
def setUserAgent(user_agent)
|
|
26
|
+
@user_agent = user_agent
|
|
27
|
+
if user_agent.is_a?(String) && user_agent.downcase.start_with?('brevo_')
|
|
28
|
+
@api_client.default_headers['User-Agent'] = @user_agent
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Get all your SMS activity (unaggregated events)
|
|
33
|
+
# @param [Hash] opts the optional parameters
|
|
34
|
+
# @option opts [Integer] :limit Number of documents per page (default to 50)
|
|
35
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
|
36
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
|
37
|
+
# @option opts [Integer] :offset Index of the first document of the page (default to 0)
|
|
38
|
+
# @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
|
39
|
+
# @option opts [String] :phone_number Filter the report for a specific phone number
|
|
40
|
+
# @option opts [String] :event Filter the report for specific events
|
|
41
|
+
# @option opts [String] :tags Filter the report for specific tags passed as a serialized urlencoded array
|
|
42
|
+
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
|
43
|
+
# @return [GetSmsEventReport]
|
|
44
|
+
def get_sms_events(opts = {})
|
|
45
|
+
data, _status_code, _headers = get_sms_events_with_http_info(opts)
|
|
46
|
+
data
|
|
47
|
+
end
|
|
48
|
+
|
|
49
|
+
# Get all your SMS activity (unaggregated events)
|
|
50
|
+
# @param [Hash] opts the optional parameters
|
|
51
|
+
# @option opts [Integer] :limit Number of documents per page
|
|
52
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
|
53
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
|
54
|
+
# @option opts [Integer] :offset Index of the first document of the page
|
|
55
|
+
# @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
|
56
|
+
# @option opts [String] :phone_number Filter the report for a specific phone number
|
|
57
|
+
# @option opts [String] :event Filter the report for specific events
|
|
58
|
+
# @option opts [String] :tags Filter the report for specific tags passed as a serialized urlencoded array
|
|
59
|
+
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
60
|
+
# @return [Array<(GetSmsEventReport, Fixnum, Hash)>] GetSmsEventReport data, response status code and response headers
|
|
61
|
+
def get_sms_events_with_http_info(opts = {})
|
|
62
|
+
if @api_client.config.debugging
|
|
63
|
+
@api_client.config.logger.debug 'Calling API: TransactionalSMSApi.get_sms_events ...'
|
|
64
|
+
end
|
|
65
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
|
|
66
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalSMSApi.get_sms_events, must be smaller than or equal to 100.'
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
if @api_client.config.client_side_validation && opts[:'event'] && !['bounces', 'hardBounces', 'softBounces', 'delivered', 'sent', 'accepted', 'unsubscription', 'replies', 'blocked', 'rejected'].include?(opts[:'event'])
|
|
70
|
+
fail ArgumentError, 'invalid value for "event", must be one of bounces, hardBounces, softBounces, delivered, sent, accepted, unsubscription, replies, blocked, rejected'
|
|
71
|
+
end
|
|
72
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
|
|
73
|
+
fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
|
|
74
|
+
end
|
|
75
|
+
# resource path
|
|
76
|
+
local_var_path = '/transactionalSMS/statistics/events'
|
|
77
|
+
|
|
78
|
+
# query parameters
|
|
79
|
+
query_params = {}
|
|
80
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
81
|
+
query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
|
|
82
|
+
query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
|
83
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
|
84
|
+
query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
|
|
85
|
+
query_params[:'phoneNumber'] = opts[:'phone_number'] if !opts[:'phone_number'].nil?
|
|
86
|
+
query_params[:'event'] = opts[:'event'] if !opts[:'event'].nil?
|
|
87
|
+
query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?
|
|
88
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
89
|
+
|
|
90
|
+
# header parameters
|
|
91
|
+
header_params = {}
|
|
92
|
+
# HTTP header 'Accept' (if needed)
|
|
93
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
94
|
+
# HTTP header 'Content-Type'
|
|
95
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
96
|
+
|
|
97
|
+
# form parameters
|
|
98
|
+
form_params = {}
|
|
99
|
+
|
|
100
|
+
# http body (model)
|
|
101
|
+
post_body = nil
|
|
102
|
+
auth_names = ['api-key', 'partner-key']
|
|
103
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
104
|
+
:header_params => header_params,
|
|
105
|
+
:query_params => query_params,
|
|
106
|
+
:form_params => form_params,
|
|
107
|
+
:body => post_body,
|
|
108
|
+
:auth_names => auth_names,
|
|
109
|
+
:return_type => 'GetSmsEventReport')
|
|
110
|
+
if @api_client.config.debugging
|
|
111
|
+
@api_client.config.logger.debug "API called: TransactionalSMSApi#get_sms_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
112
|
+
end
|
|
113
|
+
return data, status_code, headers
|
|
114
|
+
end
|
|
115
|
+
# Get your SMS activity aggregated over a period of time
|
|
116
|
+
# @param [Hash] opts the optional parameters
|
|
117
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
|
118
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
|
119
|
+
# @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with startDate and endDate
|
|
120
|
+
# @option opts [String] :tag Filter on a tag
|
|
121
|
+
# @return [GetTransacAggregatedSmsReport]
|
|
122
|
+
def get_transac_aggregated_sms_report(opts = {})
|
|
123
|
+
data, _status_code, _headers = get_transac_aggregated_sms_report_with_http_info(opts)
|
|
124
|
+
data
|
|
125
|
+
end
|
|
126
|
+
|
|
127
|
+
# Get your SMS activity aggregated over a period of time
|
|
128
|
+
# @param [Hash] opts the optional parameters
|
|
129
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
|
130
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
|
131
|
+
# @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with startDate and endDate
|
|
132
|
+
# @option opts [String] :tag Filter on a tag
|
|
133
|
+
# @return [Array<(GetTransacAggregatedSmsReport, Fixnum, Hash)>] GetTransacAggregatedSmsReport data, response status code and response headers
|
|
134
|
+
def get_transac_aggregated_sms_report_with_http_info(opts = {})
|
|
135
|
+
if @api_client.config.debugging
|
|
136
|
+
@api_client.config.logger.debug 'Calling API: TransactionalSMSApi.get_transac_aggregated_sms_report ...'
|
|
137
|
+
end
|
|
138
|
+
# resource path
|
|
139
|
+
local_var_path = '/transactionalSMS/statistics/aggregatedReport'
|
|
140
|
+
|
|
141
|
+
# query parameters
|
|
142
|
+
query_params = {}
|
|
143
|
+
query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
|
|
144
|
+
query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
|
145
|
+
query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
|
|
146
|
+
query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
|
|
147
|
+
|
|
148
|
+
# header parameters
|
|
149
|
+
header_params = {}
|
|
150
|
+
# HTTP header 'Accept' (if needed)
|
|
151
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
152
|
+
# HTTP header 'Content-Type'
|
|
153
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
154
|
+
|
|
155
|
+
# form parameters
|
|
156
|
+
form_params = {}
|
|
157
|
+
|
|
158
|
+
# http body (model)
|
|
159
|
+
post_body = nil
|
|
160
|
+
auth_names = ['api-key', 'partner-key']
|
|
161
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
162
|
+
:header_params => header_params,
|
|
163
|
+
:query_params => query_params,
|
|
164
|
+
:form_params => form_params,
|
|
165
|
+
:body => post_body,
|
|
166
|
+
:auth_names => auth_names,
|
|
167
|
+
:return_type => 'GetTransacAggregatedSmsReport')
|
|
168
|
+
if @api_client.config.debugging
|
|
169
|
+
@api_client.config.logger.debug "API called: TransactionalSMSApi#get_transac_aggregated_sms_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
170
|
+
end
|
|
171
|
+
return data, status_code, headers
|
|
172
|
+
end
|
|
173
|
+
# Get your SMS activity aggregated per day
|
|
174
|
+
# @param [Hash] opts the optional parameters
|
|
175
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
|
176
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
|
177
|
+
# @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
|
178
|
+
# @option opts [String] :tag Filter on a tag
|
|
179
|
+
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
|
180
|
+
# @return [GetTransacSmsReport]
|
|
181
|
+
def get_transac_sms_report(opts = {})
|
|
182
|
+
data, _status_code, _headers = get_transac_sms_report_with_http_info(opts)
|
|
183
|
+
data
|
|
184
|
+
end
|
|
185
|
+
|
|
186
|
+
# Get your SMS activity aggregated per day
|
|
187
|
+
# @param [Hash] opts the optional parameters
|
|
188
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
|
189
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
|
190
|
+
# @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
|
191
|
+
# @option opts [String] :tag Filter on a tag
|
|
192
|
+
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
193
|
+
# @return [Array<(GetTransacSmsReport, Fixnum, Hash)>] GetTransacSmsReport data, response status code and response headers
|
|
194
|
+
def get_transac_sms_report_with_http_info(opts = {})
|
|
195
|
+
if @api_client.config.debugging
|
|
196
|
+
@api_client.config.logger.debug 'Calling API: TransactionalSMSApi.get_transac_sms_report ...'
|
|
197
|
+
end
|
|
198
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
|
|
199
|
+
fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
|
|
200
|
+
end
|
|
201
|
+
# resource path
|
|
202
|
+
local_var_path = '/transactionalSMS/statistics/reports'
|
|
203
|
+
|
|
204
|
+
# query parameters
|
|
205
|
+
query_params = {}
|
|
206
|
+
query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
|
|
207
|
+
query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
|
208
|
+
query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
|
|
209
|
+
query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
|
|
210
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
211
|
+
|
|
212
|
+
# header parameters
|
|
213
|
+
header_params = {}
|
|
214
|
+
# HTTP header 'Accept' (if needed)
|
|
215
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
216
|
+
# HTTP header 'Content-Type'
|
|
217
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
218
|
+
|
|
219
|
+
# form parameters
|
|
220
|
+
form_params = {}
|
|
221
|
+
|
|
222
|
+
# http body (model)
|
|
223
|
+
post_body = nil
|
|
224
|
+
auth_names = ['api-key', 'partner-key']
|
|
225
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
226
|
+
:header_params => header_params,
|
|
227
|
+
:query_params => query_params,
|
|
228
|
+
:form_params => form_params,
|
|
229
|
+
:body => post_body,
|
|
230
|
+
:auth_names => auth_names,
|
|
231
|
+
:return_type => 'GetTransacSmsReport')
|
|
232
|
+
if @api_client.config.debugging
|
|
233
|
+
@api_client.config.logger.debug "API called: TransactionalSMSApi#get_transac_sms_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
234
|
+
end
|
|
235
|
+
return data, status_code, headers
|
|
236
|
+
end
|
|
237
|
+
# Send SMS message to a mobile number
|
|
238
|
+
# @param send_transac_sms Values to send a transactional SMS
|
|
239
|
+
# @param [Hash] opts the optional parameters
|
|
240
|
+
# @return [SendSms]
|
|
241
|
+
def send_transac_sms(send_transac_sms, opts = {})
|
|
242
|
+
data, _status_code, _headers = send_transac_sms_with_http_info(send_transac_sms, opts)
|
|
243
|
+
data
|
|
244
|
+
end
|
|
245
|
+
|
|
246
|
+
# Send SMS message to a mobile number
|
|
247
|
+
# @param send_transac_sms Values to send a transactional SMS
|
|
248
|
+
# @param [Hash] opts the optional parameters
|
|
249
|
+
# @return [Array<(SendSms, Fixnum, Hash)>] SendSms data, response status code and response headers
|
|
250
|
+
def send_transac_sms_with_http_info(send_transac_sms, opts = {})
|
|
251
|
+
if @api_client.config.debugging
|
|
252
|
+
@api_client.config.logger.debug 'Calling API: TransactionalSMSApi.send_transac_sms ...'
|
|
253
|
+
end
|
|
254
|
+
# verify the required parameter 'send_transac_sms' is set
|
|
255
|
+
if @api_client.config.client_side_validation && send_transac_sms.nil?
|
|
256
|
+
fail ArgumentError, "Missing the required parameter 'send_transac_sms' when calling TransactionalSMSApi.send_transac_sms"
|
|
257
|
+
end
|
|
258
|
+
# resource path
|
|
259
|
+
local_var_path = '/transactionalSMS/sms'
|
|
260
|
+
|
|
261
|
+
# query parameters
|
|
262
|
+
query_params = {}
|
|
263
|
+
|
|
264
|
+
# header parameters
|
|
265
|
+
header_params = {}
|
|
266
|
+
# HTTP header 'Accept' (if needed)
|
|
267
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
268
|
+
# HTTP header 'Content-Type'
|
|
269
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
270
|
+
|
|
271
|
+
# form parameters
|
|
272
|
+
form_params = {}
|
|
273
|
+
|
|
274
|
+
# http body (model)
|
|
275
|
+
post_body = @api_client.object_to_http_body(send_transac_sms)
|
|
276
|
+
auth_names = ['api-key', 'partner-key']
|
|
277
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
278
|
+
:header_params => header_params,
|
|
279
|
+
:query_params => query_params,
|
|
280
|
+
:form_params => form_params,
|
|
281
|
+
:body => post_body,
|
|
282
|
+
:auth_names => auth_names,
|
|
283
|
+
:return_type => 'SendSms')
|
|
284
|
+
if @api_client.config.debugging
|
|
285
|
+
@api_client.config.logger.debug "API called: TransactionalSMSApi#send_transac_sms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
286
|
+
end
|
|
287
|
+
return data, status_code, headers
|
|
288
|
+
end
|
|
289
|
+
end
|
|
290
|
+
end
|
|
@@ -0,0 +1,173 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Brevo API
|
|
3
|
+
|
|
4
|
+
#Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/getbrevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
|
5
|
+
|
|
6
|
+
OpenAPI spec version: 3.0.0
|
|
7
|
+
Contact: contact@brevo.com
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
+
Swagger Codegen version: 2.4.19
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'uri'
|
|
14
|
+
|
|
15
|
+
module BrevoRuby
|
|
16
|
+
class TransactionalWhatsAppApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
# Set custom user_agent if explicitly passed in api
|
|
24
|
+
# default will still remain Swagger-Codegen/#{VERSION}/ruby
|
|
25
|
+
def setUserAgent(user_agent)
|
|
26
|
+
@user_agent = user_agent
|
|
27
|
+
if user_agent.is_a?(String) && user_agent.downcase.start_with?('brevo_')
|
|
28
|
+
@api_client.default_headers['User-Agent'] = @user_agent
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Get all your WhatsApp activity (unaggregated events)
|
|
33
|
+
# This endpoint will show the unaggregated statistics for WhatsApp activity (30 days by default if `startDate` and `endDate` or `days` is not passed. The date range can not exceed 90 days)
|
|
34
|
+
# @param [Hash] opts the optional parameters
|
|
35
|
+
# @option opts [Integer] :limit Number limitation for the result returned (default to 2500)
|
|
36
|
+
# @option opts [Integer] :offset Beginning point in the list to retrieve from (default to 0)
|
|
37
|
+
# @option opts [String] :start_date **Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
|
38
|
+
# @option opts [String] :end_date **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
|
39
|
+
# @option opts [Integer] :days Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_
|
|
40
|
+
# @option opts [String] :contact_number Filter results for specific contact (WhatsApp Number with country code. Example, 85264318721)
|
|
41
|
+
# @option opts [String] :event Filter the report for a specific event type
|
|
42
|
+
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
|
43
|
+
# @return [GetWhatsappEventReport]
|
|
44
|
+
def get_whatsapp_event_report(opts = {})
|
|
45
|
+
data, _status_code, _headers = get_whatsapp_event_report_with_http_info(opts)
|
|
46
|
+
data
|
|
47
|
+
end
|
|
48
|
+
|
|
49
|
+
# Get all your WhatsApp activity (unaggregated events)
|
|
50
|
+
# This endpoint will show the unaggregated statistics for WhatsApp activity (30 days by default if `startDate` and `endDate` or `days` is not passed. The date range can not exceed 90 days)
|
|
51
|
+
# @param [Hash] opts the optional parameters
|
|
52
|
+
# @option opts [Integer] :limit Number limitation for the result returned
|
|
53
|
+
# @option opts [Integer] :offset Beginning point in the list to retrieve from
|
|
54
|
+
# @option opts [String] :start_date **Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
|
55
|
+
# @option opts [String] :end_date **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
|
56
|
+
# @option opts [Integer] :days Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_
|
|
57
|
+
# @option opts [String] :contact_number Filter results for specific contact (WhatsApp Number with country code. Example, 85264318721)
|
|
58
|
+
# @option opts [String] :event Filter the report for a specific event type
|
|
59
|
+
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
60
|
+
# @return [Array<(GetWhatsappEventReport, Fixnum, Hash)>] GetWhatsappEventReport data, response status code and response headers
|
|
61
|
+
def get_whatsapp_event_report_with_http_info(opts = {})
|
|
62
|
+
if @api_client.config.debugging
|
|
63
|
+
@api_client.config.logger.debug 'Calling API: TransactionalWhatsAppApi.get_whatsapp_event_report ...'
|
|
64
|
+
end
|
|
65
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 5000
|
|
66
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalWhatsAppApi.get_whatsapp_event_report, must be smaller than or equal to 5000.'
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
|
|
70
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalWhatsAppApi.get_whatsapp_event_report, must be greater than or equal to 0.'
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
if @api_client.config.client_side_validation && opts[:'event'] && !['sent', 'delivered', 'read', 'error', 'unsubscribe', 'reply', 'soft-bounce'].include?(opts[:'event'])
|
|
74
|
+
fail ArgumentError, 'invalid value for "event", must be one of sent, delivered, read, error, unsubscribe, reply, soft-bounce'
|
|
75
|
+
end
|
|
76
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
|
|
77
|
+
fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
|
|
78
|
+
end
|
|
79
|
+
# resource path
|
|
80
|
+
local_var_path = '/whatsapp/statistics/events'
|
|
81
|
+
|
|
82
|
+
# query parameters
|
|
83
|
+
query_params = {}
|
|
84
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
85
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
|
86
|
+
query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
|
|
87
|
+
query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
|
88
|
+
query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
|
|
89
|
+
query_params[:'contactNumber'] = opts[:'contact_number'] if !opts[:'contact_number'].nil?
|
|
90
|
+
query_params[:'event'] = opts[:'event'] if !opts[:'event'].nil?
|
|
91
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
92
|
+
|
|
93
|
+
# header parameters
|
|
94
|
+
header_params = {}
|
|
95
|
+
# HTTP header 'Accept' (if needed)
|
|
96
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
97
|
+
# HTTP header 'Content-Type'
|
|
98
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
99
|
+
|
|
100
|
+
# form parameters
|
|
101
|
+
form_params = {}
|
|
102
|
+
|
|
103
|
+
# http body (model)
|
|
104
|
+
post_body = nil
|
|
105
|
+
auth_names = ['api-key', 'partner-key']
|
|
106
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
107
|
+
:header_params => header_params,
|
|
108
|
+
:query_params => query_params,
|
|
109
|
+
:form_params => form_params,
|
|
110
|
+
:body => post_body,
|
|
111
|
+
:auth_names => auth_names,
|
|
112
|
+
:return_type => 'GetWhatsappEventReport')
|
|
113
|
+
if @api_client.config.debugging
|
|
114
|
+
@api_client.config.logger.debug "API called: TransactionalWhatsAppApi#get_whatsapp_event_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
115
|
+
end
|
|
116
|
+
return data, status_code, headers
|
|
117
|
+
end
|
|
118
|
+
# Send a WhatsApp message
|
|
119
|
+
# This endpoint is used to send a WhatsApp message. <br/>(**The first message you send using the API must contain a Template ID. You must create a template on WhatsApp on the Brevo platform to fetch the Template ID.**)
|
|
120
|
+
# @param send_whatsapp_message Values to send WhatsApp message
|
|
121
|
+
# @param [Hash] opts the optional parameters
|
|
122
|
+
# @return [InlineResponse2013]
|
|
123
|
+
def send_whatsapp_message(send_whatsapp_message, opts = {})
|
|
124
|
+
data, _status_code, _headers = send_whatsapp_message_with_http_info(send_whatsapp_message, opts)
|
|
125
|
+
data
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
# Send a WhatsApp message
|
|
129
|
+
# This endpoint is used to send a WhatsApp message. <br/>(**The first message you send using the API must contain a Template ID. You must create a template on WhatsApp on the Brevo platform to fetch the Template ID.**)
|
|
130
|
+
# @param send_whatsapp_message Values to send WhatsApp message
|
|
131
|
+
# @param [Hash] opts the optional parameters
|
|
132
|
+
# @return [Array<(InlineResponse2013, Fixnum, Hash)>] InlineResponse2013 data, response status code and response headers
|
|
133
|
+
def send_whatsapp_message_with_http_info(send_whatsapp_message, opts = {})
|
|
134
|
+
if @api_client.config.debugging
|
|
135
|
+
@api_client.config.logger.debug 'Calling API: TransactionalWhatsAppApi.send_whatsapp_message ...'
|
|
136
|
+
end
|
|
137
|
+
# verify the required parameter 'send_whatsapp_message' is set
|
|
138
|
+
if @api_client.config.client_side_validation && send_whatsapp_message.nil?
|
|
139
|
+
fail ArgumentError, "Missing the required parameter 'send_whatsapp_message' when calling TransactionalWhatsAppApi.send_whatsapp_message"
|
|
140
|
+
end
|
|
141
|
+
# resource path
|
|
142
|
+
local_var_path = '/whatsapp/sendMessage'
|
|
143
|
+
|
|
144
|
+
# query parameters
|
|
145
|
+
query_params = {}
|
|
146
|
+
|
|
147
|
+
# header parameters
|
|
148
|
+
header_params = {}
|
|
149
|
+
# HTTP header 'Accept' (if needed)
|
|
150
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
151
|
+
# HTTP header 'Content-Type'
|
|
152
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
153
|
+
|
|
154
|
+
# form parameters
|
|
155
|
+
form_params = {}
|
|
156
|
+
|
|
157
|
+
# http body (model)
|
|
158
|
+
post_body = @api_client.object_to_http_body(send_whatsapp_message)
|
|
159
|
+
auth_names = ['api-key', 'partner-key']
|
|
160
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
161
|
+
:header_params => header_params,
|
|
162
|
+
:query_params => query_params,
|
|
163
|
+
:form_params => form_params,
|
|
164
|
+
:body => post_body,
|
|
165
|
+
:auth_names => auth_names,
|
|
166
|
+
:return_type => 'InlineResponse2013')
|
|
167
|
+
if @api_client.config.debugging
|
|
168
|
+
@api_client.config.logger.debug "API called: TransactionalWhatsAppApi#send_whatsapp_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
169
|
+
end
|
|
170
|
+
return data, status_code, headers
|
|
171
|
+
end
|
|
172
|
+
end
|
|
173
|
+
end
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Brevo API
|
|
3
|
+
|
|
4
|
+
#Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/getbrevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
|
5
|
+
|
|
6
|
+
OpenAPI spec version: 3.0.0
|
|
7
|
+
Contact: contact@brevo.com
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
+
Swagger Codegen version: 2.4.19
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'uri'
|
|
14
|
+
|
|
15
|
+
module BrevoRuby
|
|
16
|
+
class UserApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
# Set custom user_agent if explicitly passed in api
|
|
24
|
+
# default will still remain Swagger-Codegen/#{VERSION}/ruby
|
|
25
|
+
def setUserAgent(user_agent)
|
|
26
|
+
@user_agent = user_agent
|
|
27
|
+
if user_agent.is_a?(String) && user_agent.downcase.start_with?('brevo_')
|
|
28
|
+
@api_client.default_headers['User-Agent'] = @user_agent
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Get the list of all your users
|
|
33
|
+
# @param [Hash] opts the optional parameters
|
|
34
|
+
# @return [GetInvitedUsersList]
|
|
35
|
+
def get_invited_users_list(opts = {})
|
|
36
|
+
data, _status_code, _headers = get_invited_users_list_with_http_info(opts)
|
|
37
|
+
data
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
# Get the list of all your users
|
|
41
|
+
# @param [Hash] opts the optional parameters
|
|
42
|
+
# @return [Array<(GetInvitedUsersList, Fixnum, Hash)>] GetInvitedUsersList data, response status code and response headers
|
|
43
|
+
def get_invited_users_list_with_http_info(opts = {})
|
|
44
|
+
if @api_client.config.debugging
|
|
45
|
+
@api_client.config.logger.debug 'Calling API: UserApi.get_invited_users_list ...'
|
|
46
|
+
end
|
|
47
|
+
# resource path
|
|
48
|
+
local_var_path = '/organization/invited/users'
|
|
49
|
+
|
|
50
|
+
# query parameters
|
|
51
|
+
query_params = {}
|
|
52
|
+
|
|
53
|
+
# header parameters
|
|
54
|
+
header_params = {}
|
|
55
|
+
# HTTP header 'Accept' (if needed)
|
|
56
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
57
|
+
# HTTP header 'Content-Type'
|
|
58
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
59
|
+
|
|
60
|
+
# form parameters
|
|
61
|
+
form_params = {}
|
|
62
|
+
|
|
63
|
+
# http body (model)
|
|
64
|
+
post_body = nil
|
|
65
|
+
auth_names = ['api-key', 'partner-key']
|
|
66
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
67
|
+
:header_params => header_params,
|
|
68
|
+
:query_params => query_params,
|
|
69
|
+
:form_params => form_params,
|
|
70
|
+
:body => post_body,
|
|
71
|
+
:auth_names => auth_names,
|
|
72
|
+
:return_type => 'GetInvitedUsersList')
|
|
73
|
+
if @api_client.config.debugging
|
|
74
|
+
@api_client.config.logger.debug "API called: UserApi#get_invited_users_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
75
|
+
end
|
|
76
|
+
return data, status_code, headers
|
|
77
|
+
end
|
|
78
|
+
# Check user permission
|
|
79
|
+
# @param email Email of the invited user.
|
|
80
|
+
# @param [Hash] opts the optional parameters
|
|
81
|
+
# @return [GetUserPermission]
|
|
82
|
+
def get_user_permission(email, opts = {})
|
|
83
|
+
data, _status_code, _headers = get_user_permission_with_http_info(email, opts)
|
|
84
|
+
data
|
|
85
|
+
end
|
|
86
|
+
|
|
87
|
+
# Check user permission
|
|
88
|
+
# @param email Email of the invited user.
|
|
89
|
+
# @param [Hash] opts the optional parameters
|
|
90
|
+
# @return [Array<(GetUserPermission, Fixnum, Hash)>] GetUserPermission data, response status code and response headers
|
|
91
|
+
def get_user_permission_with_http_info(email, opts = {})
|
|
92
|
+
if @api_client.config.debugging
|
|
93
|
+
@api_client.config.logger.debug 'Calling API: UserApi.get_user_permission ...'
|
|
94
|
+
end
|
|
95
|
+
# verify the required parameter 'email' is set
|
|
96
|
+
if @api_client.config.client_side_validation && email.nil?
|
|
97
|
+
fail ArgumentError, "Missing the required parameter 'email' when calling UserApi.get_user_permission"
|
|
98
|
+
end
|
|
99
|
+
# resource path
|
|
100
|
+
local_var_path = '/organization/user/{email}/permissions'.sub('{' + 'email' + '}', email.to_s)
|
|
101
|
+
|
|
102
|
+
# query parameters
|
|
103
|
+
query_params = {}
|
|
104
|
+
|
|
105
|
+
# header parameters
|
|
106
|
+
header_params = {}
|
|
107
|
+
# HTTP header 'Accept' (if needed)
|
|
108
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
109
|
+
# HTTP header 'Content-Type'
|
|
110
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
111
|
+
|
|
112
|
+
# form parameters
|
|
113
|
+
form_params = {}
|
|
114
|
+
|
|
115
|
+
# http body (model)
|
|
116
|
+
post_body = nil
|
|
117
|
+
auth_names = ['api-key', 'partner-key']
|
|
118
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
119
|
+
:header_params => header_params,
|
|
120
|
+
:query_params => query_params,
|
|
121
|
+
:form_params => form_params,
|
|
122
|
+
:body => post_body,
|
|
123
|
+
:auth_names => auth_names,
|
|
124
|
+
:return_type => 'GetUserPermission')
|
|
125
|
+
if @api_client.config.debugging
|
|
126
|
+
@api_client.config.logger.debug "API called: UserApi#get_user_permission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
127
|
+
end
|
|
128
|
+
return data, status_code, headers
|
|
129
|
+
end
|
|
130
|
+
end
|
|
131
|
+
end
|