@getbrevo/brevo 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.
- package/.eslintignore +2 -0
- package/.eslintrc +22 -0
- package/.github/CODEOWNERS +1 -0
- package/.github/workflows/release.yml +20 -0
- package/.swagger-codegen/VERSION +1 -0
- package/.swagger-codegen-ignore +23 -0
- package/.travis.yml +5 -0
- package/LICENSE.md +15 -0
- package/README.md +683 -0
- package/docs/AbTestCampaignResult.md +43 -0
- package/docs/AbTestCampaignResultClickedLinks.md +9 -0
- package/docs/AbTestCampaignResultStatistics.md +13 -0
- package/docs/AbTestVersionClicks.md +7 -0
- package/docs/AbTestVersionClicksInner.md +10 -0
- package/docs/AbTestVersionStats.md +9 -0
- package/docs/AccountApi.md +119 -0
- package/docs/AddChildDomain.md +8 -0
- package/docs/AddContactToList.md +9 -0
- package/docs/AddCredits.md +9 -0
- package/docs/AuthenticateDomainModel.md +9 -0
- package/docs/BlockDomain.md +8 -0
- package/docs/Body.md +10 -0
- package/docs/Body1.md +10 -0
- package/docs/Body10.md +11 -0
- package/docs/Body11.md +8 -0
- package/docs/Body12.md +11 -0
- package/docs/Body2.md +11 -0
- package/docs/Body3.md +9 -0
- package/docs/Body4.md +9 -0
- package/docs/Body5.md +11 -0
- package/docs/Body6.md +18 -0
- package/docs/Body7.md +17 -0
- package/docs/Body8.md +13 -0
- package/docs/Body9.md +8 -0
- package/docs/BodyVariablesItems.md +7 -0
- package/docs/CompaniesApi.md +406 -0
- package/docs/CompaniesList.md +8 -0
- package/docs/Company.md +11 -0
- package/docs/CompanyAttributes.md +7 -0
- package/docs/CompanyAttributesInner.md +12 -0
- package/docs/ComponentItems.md +9 -0
- package/docs/ContactsApi.md +1691 -0
- package/docs/ConversationsApi.md +518 -0
- package/docs/ConversationsMessage.md +28 -0
- package/docs/ConversationsMessageFile.md +12 -0
- package/docs/ConversationsMessageFileImageInfo.md +10 -0
- package/docs/CouponsApi.md +291 -0
- package/docs/CreateApiKeyRequest.md +9 -0
- package/docs/CreateApiKeyResponse.md +9 -0
- package/docs/CreateAttribute.md +30 -0
- package/docs/CreateAttributeEnumeration.md +9 -0
- package/docs/CreateCategoryModel.md +8 -0
- package/docs/CreateChild.md +32 -0
- package/docs/CreateContact.md +15 -0
- package/docs/CreateCouponCollection.md +9 -0
- package/docs/CreateCoupons.md +9 -0
- package/docs/CreateDoiContact.md +13 -0
- package/docs/CreateDomain.md +8 -0
- package/docs/CreateDomainModel.md +11 -0
- package/docs/CreateDomainModelDnsRecords.md +9 -0
- package/docs/CreateDomainModelDnsRecordsDkimRecord.md +11 -0
- package/docs/CreateEmailCampaign.md +49 -0
- package/docs/CreateEmailCampaignRecipients.md +10 -0
- package/docs/CreateEmailCampaignSender.md +10 -0
- package/docs/CreateExternalFeed.md +29 -0
- package/docs/CreateList.md +9 -0
- package/docs/CreateModel.md +8 -0
- package/docs/CreateProductModel.md +8 -0
- package/docs/CreateReseller.md +9 -0
- package/docs/CreateSender.md +10 -0
- package/docs/CreateSenderIps.md +10 -0
- package/docs/CreateSenderModel.md +10 -0
- package/docs/CreateSmsCampaign.md +15 -0
- package/docs/CreateSmsCampaignRecipients.md +9 -0
- package/docs/CreateSmtpEmail.md +9 -0
- package/docs/CreateSmtpTemplate.md +17 -0
- package/docs/CreateSmtpTemplateSender.md +10 -0
- package/docs/CreateSubAccount.md +30 -0
- package/docs/CreateSubAccountResponse.md +8 -0
- package/docs/CreateUpdateBatchCategory.md +9 -0
- package/docs/CreateUpdateBatchCategoryModel.md +9 -0
- package/docs/CreateUpdateBatchProducts.md +9 -0
- package/docs/CreateUpdateBatchProductsModel.md +9 -0
- package/docs/CreateUpdateCategories.md +11 -0
- package/docs/CreateUpdateCategory.md +12 -0
- package/docs/CreateUpdateContactModel.md +8 -0
- package/docs/CreateUpdateFolder.md +8 -0
- package/docs/CreateUpdateProduct.md +18 -0
- package/docs/CreateUpdateProducts.md +17 -0
- package/docs/CreateWebhook.md +66 -0
- package/docs/CreateWhatsAppCampaign.md +11 -0
- package/docs/CreateWhatsAppCampaignRecipients.md +10 -0
- package/docs/CreateWhatsAppTemplate.md +24 -0
- package/docs/CreatedBatchId.md +8 -0
- package/docs/CreatedProcessId.md +8 -0
- package/docs/Deal.md +11 -0
- package/docs/DealAttributes.md +7 -0
- package/docs/DealAttributesInner.md +12 -0
- package/docs/DealsApi.md +512 -0
- package/docs/DealsList.md +8 -0
- package/docs/DeleteHardbounces.md +10 -0
- package/docs/DomainsApi.md +278 -0
- package/docs/EcommerceApi.md +645 -0
- package/docs/EmailCampaignsApi.md +766 -0
- package/docs/EmailExportRecipients.md +32 -0
- package/docs/ErrorModel.md +48 -0
- package/docs/ExportWebhooksHistory.md +57 -0
- package/docs/ExternalFeedsApi.md +309 -0
- package/docs/FileData.md +14 -0
- package/docs/FileDownloadableLink.md +8 -0
- package/docs/FileList.md +7 -0
- package/docs/FilesApi.md +304 -0
- package/docs/GetAccount.md +10 -0
- package/docs/GetAccountActivity.md +8 -0
- package/docs/GetAccountActivityLogs.md +12 -0
- package/docs/GetAccountMarketingAutomation.md +9 -0
- package/docs/GetAccountPlan.md +39 -0
- package/docs/GetAccountRelay.md +9 -0
- package/docs/GetAccountRelayData.md +10 -0
- package/docs/GetAggregatedReport.md +20 -0
- package/docs/GetAllExternalFeeds.md +9 -0
- package/docs/GetAllExternalFeedsFeeds.md +32 -0
- package/docs/GetAttributes.md +8 -0
- package/docs/GetAttributesAttributes.md +46 -0
- package/docs/GetAttributesEnumeration.md +9 -0
- package/docs/GetBlockedDomains.md +8 -0
- package/docs/GetCampaignOverview.md +51 -0
- package/docs/GetCampaignRecipients.md +9 -0
- package/docs/GetCampaignStats.md +23 -0
- package/docs/GetCategories.md +9 -0
- package/docs/GetCategoryDetails.md +13 -0
- package/docs/GetChildAccountCreationStatus.md +8 -0
- package/docs/GetChildDomain.md +9 -0
- package/docs/GetChildDomains.md +7 -0
- package/docs/GetChildInfo.md +12 -0
- package/docs/GetChildInfoApiKeys.md +9 -0
- package/docs/GetChildInfoApiKeysV2.md +9 -0
- package/docs/GetChildInfoApiKeysV3.md +9 -0
- package/docs/GetChildInfoCredits.md +9 -0
- package/docs/GetChildInfoStatistics.md +10 -0
- package/docs/GetChildrenList.md +9 -0
- package/docs/GetClient.md +11 -0
- package/docs/GetContactCampaignStats.md +16 -0
- package/docs/GetContactCampaignStatsClicked.md +9 -0
- package/docs/GetContactCampaignStatsOpened.md +11 -0
- package/docs/GetContactCampaignStatsTransacAttributes.md +10 -0
- package/docs/GetContactCampaignStatsUnsubscriptions.md +9 -0
- package/docs/GetContactDetails.md +16 -0
- package/docs/GetContacts.md +9 -0
- package/docs/GetCouponCollection.md +13 -0
- package/docs/GetDeviceBrowserStats.md +11 -0
- package/docs/GetDomainConfigurationModel.md +11 -0
- package/docs/GetDomainsList.md +8 -0
- package/docs/GetDomainsListDomains.md +12 -0
- package/docs/GetEmailCampaign.md +9 -0
- package/docs/GetEmailCampaigns.md +9 -0
- package/docs/GetEmailEventReport.md +8 -0
- package/docs/GetEmailEventReportEvents.md +53 -0
- package/docs/GetExtendedCampaignOverview.md +23 -0
- package/docs/GetExtendedCampaignOverviewSender.md +10 -0
- package/docs/GetExtendedCampaignStats.md +15 -0
- package/docs/GetExtendedCampaignStatsGlobalStats.md +7 -0
- package/docs/GetExtendedClient.md +8 -0
- package/docs/GetExtendedClientAddress.md +11 -0
- package/docs/GetExtendedContactDetails.md +8 -0
- package/docs/GetExtendedContactDetailsStatistics.md +16 -0
- package/docs/GetExtendedContactDetailsStatisticsClicked.md +9 -0
- package/docs/GetExtendedContactDetailsStatisticsLinks.md +11 -0
- package/docs/GetExtendedContactDetailsStatisticsMessagesSent.md +9 -0
- package/docs/GetExtendedContactDetailsStatisticsOpened.md +11 -0
- package/docs/GetExtendedContactDetailsStatisticsUnsubscriptions.md +9 -0
- package/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +9 -0
- package/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +10 -0
- package/docs/GetExtendedList.md +11 -0
- package/docs/GetExtendedListCampaignStats.md +9 -0
- package/docs/GetExternalFeedByUUID.md +32 -0
- package/docs/GetExternalFeedByUUIDHeaders.md +9 -0
- package/docs/GetFolder.md +12 -0
- package/docs/GetFolderLists.md +9 -0
- package/docs/GetFolders.md +9 -0
- package/docs/GetInboundEmailEvents.md +8 -0
- package/docs/GetInboundEmailEventsByUuid.md +15 -0
- package/docs/GetInboundEmailEventsByUuidAttachments.md +11 -0
- package/docs/GetInboundEmailEventsByUuidLogs.md +24 -0
- package/docs/GetInboundEmailEventsEvents.md +11 -0
- package/docs/GetInvitedUsersList.md +8 -0
- package/docs/GetInvitedUsersListFeatureAccess.md +10 -0
- package/docs/GetInvitedUsersListUsers.md +11 -0
- package/docs/GetIp.md +11 -0
- package/docs/GetIpFromSender.md +11 -0
- package/docs/GetIps.md +8 -0
- package/docs/GetIpsFromSender.md +8 -0
- package/docs/GetList.md +12 -0
- package/docs/GetLists.md +9 -0
- package/docs/GetProcess.md +24 -0
- package/docs/GetProcesses.md +9 -0
- package/docs/GetProductDetails.md +22 -0
- package/docs/GetProducts.md +9 -0
- package/docs/GetReports.md +8 -0
- package/docs/GetReportsReports.md +20 -0
- package/docs/GetScheduledEmailByBatchId.md +9 -0
- package/docs/GetScheduledEmailByBatchIdBatches.md +25 -0
- package/docs/GetScheduledEmailByMessageId.md +25 -0
- package/docs/GetSegments.md +9 -0
- package/docs/GetSegmentsSegments.md +11 -0
- package/docs/GetSendersList.md +8 -0
- package/docs/GetSendersListIps.md +10 -0
- package/docs/GetSendersListSenders.md +12 -0
- package/docs/GetSharedTemplateUrl.md +8 -0
- package/docs/GetSmsCampaign.md +9 -0
- package/docs/GetSmsCampaignOverview.md +34 -0
- package/docs/GetSmsCampaignRecipients.md +7 -0
- package/docs/GetSmsCampaignStats.md +14 -0
- package/docs/GetSmsCampaigns.md +9 -0
- package/docs/GetSmsEventReport.md +8 -0
- package/docs/GetSmsEventReportEvents.md +41 -0
- package/docs/GetSmtpTemplateOverview.md +20 -0
- package/docs/GetSmtpTemplateOverviewSender.md +10 -0
- package/docs/GetSmtpTemplates.md +9 -0
- package/docs/GetSsoToken.md +8 -0
- package/docs/GetStatsByBrowser.md +7 -0
- package/docs/GetStatsByDevice.md +11 -0
- package/docs/GetStatsByDomain.md +7 -0
- package/docs/GetTransacAggregatedSmsReport.md +17 -0
- package/docs/GetTransacBlockedContacts.md +9 -0
- package/docs/GetTransacBlockedContactsContacts.md +11 -0
- package/docs/GetTransacBlockedContactsReason.md +28 -0
- package/docs/GetTransacEmailContent.md +14 -0
- package/docs/GetTransacEmailContentEvents.md +9 -0
- package/docs/GetTransacEmailsList.md +9 -0
- package/docs/GetTransacEmailsListTransactionalEmails.md +15 -0
- package/docs/GetTransacSmsReport.md +8 -0
- package/docs/GetTransacSmsReportReports.md +17 -0
- package/docs/GetUserPermission.md +10 -0
- package/docs/GetUserPermissionPrivileges.md +9 -0
- package/docs/GetWATemplates.md +9 -0
- package/docs/GetWATemplatesTemplates.md +15 -0
- package/docs/GetWebhook.md +25 -0
- package/docs/GetWebhooks.md +8 -0
- package/docs/GetWhatsAppConfig.md +39 -0
- package/docs/GetWhatsappCampaignOverview.md +39 -0
- package/docs/GetWhatsappCampaigns.md +9 -0
- package/docs/GetWhatsappCampaignsCampaigns.md +41 -0
- package/docs/GetWhatsappEventReport.md +8 -0
- package/docs/GetWhatsappEventReportEvents.md +36 -0
- package/docs/InboundParsingApi.md +190 -0
- package/docs/InlineResponse200.md +8 -0
- package/docs/InlineResponse2001.md +10 -0
- package/docs/InlineResponse201.md +8 -0
- package/docs/InlineResponse2011.md +8 -0
- package/docs/InlineResponse2012.md +8 -0
- package/docs/InlineResponse2013.md +8 -0
- package/docs/InlineResponse2014.md +8 -0
- package/docs/ManageIp.md +8 -0
- package/docs/MasterAccountApi.md +524 -0
- package/docs/MasterDetailsResponse.md +14 -0
- package/docs/MasterDetailsResponseBillingInfo.md +11 -0
- package/docs/MasterDetailsResponseBillingInfoAddress.md +12 -0
- package/docs/MasterDetailsResponseBillingInfoName.md +9 -0
- package/docs/MasterDetailsResponsePlanInfo.md +24 -0
- package/docs/MasterDetailsResponsePlanInfoFeatures.md +12 -0
- package/docs/Note.md +14 -0
- package/docs/NoteData.md +11 -0
- package/docs/NoteId.md +8 -0
- package/docs/NoteList.md +7 -0
- package/docs/NotesApi.md +299 -0
- package/docs/Order.md +16 -0
- package/docs/OrderBatch.md +9 -0
- package/docs/OrderBilling.md +14 -0
- package/docs/OrderProducts.md +11 -0
- package/docs/Otp.md +8 -0
- package/docs/Pipeline.md +10 -0
- package/docs/PipelineStage.md +9 -0
- package/docs/Pipelines.md +7 -0
- package/docs/PostContactInfo.md +8 -0
- package/docs/PostContactInfoContacts.md +11 -0
- package/docs/PostSendFailed.md +12 -0
- package/docs/PostSendSmsTestFailed.md +11 -0
- package/docs/ProcessApi.md +123 -0
- package/docs/RemainingCreditModel.md +9 -0
- package/docs/RemainingCreditModelChild.md +9 -0
- package/docs/RemainingCreditModelReseller.md +9 -0
- package/docs/RemoveContactFromList.md +10 -0
- package/docs/RemoveCredits.md +9 -0
- package/docs/RequestContactExport.md +10 -0
- package/docs/RequestContactExportCustomContactFilter.md +62 -0
- package/docs/RequestContactImport.md +17 -0
- package/docs/RequestContactImportNewList.md +9 -0
- package/docs/RequestSmsRecipientExport.md +28 -0
- package/docs/ResellerApi.md +924 -0
- package/docs/SMSCampaignsApi.md +589 -0
- package/docs/ScheduleSmtpEmail.md +10 -0
- package/docs/SendReport.md +28 -0
- package/docs/SendReportEmail.md +9 -0
- package/docs/SendSms.md +12 -0
- package/docs/SendSmtpEmail.md +23 -0
- package/docs/SendSmtpEmailAttachment.md +10 -0
- package/docs/SendSmtpEmailBcc.md +9 -0
- package/docs/SendSmtpEmailCc.md +9 -0
- package/docs/SendSmtpEmailMessageVersions.md +13 -0
- package/docs/SendSmtpEmailReplyTo.md +9 -0
- package/docs/SendSmtpEmailReplyTo1.md +9 -0
- package/docs/SendSmtpEmailSender.md +10 -0
- package/docs/SendSmtpEmailTo.md +9 -0
- package/docs/SendSmtpEmailTo1.md +9 -0
- package/docs/SendTestEmail.md +8 -0
- package/docs/SendTestSms.md +8 -0
- package/docs/SendTransacSms.md +26 -0
- package/docs/SendWhatsappMessage.md +11 -0
- package/docs/SendersApi.md +399 -0
- package/docs/SsoTokenRequest.md +33 -0
- package/docs/SubAccountDetailsResponse.md +11 -0
- package/docs/SubAccountDetailsResponsePlanInfo.md +10 -0
- package/docs/SubAccountDetailsResponsePlanInfoCredits.md +9 -0
- package/docs/SubAccountDetailsResponsePlanInfoCreditsEmails.md +9 -0
- package/docs/SubAccountDetailsResponsePlanInfoFeatures.md +10 -0
- package/docs/SubAccountDetailsResponsePlanInfoFeaturesInbox.md +9 -0
- package/docs/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md +9 -0
- package/docs/SubAccountDetailsResponsePlanInfoFeaturesUsers.md +9 -0
- package/docs/SubAccountUpdatePlanRequest.md +9 -0
- package/docs/SubAccountUpdatePlanRequestCredits.md +8 -0
- package/docs/SubAccountUpdatePlanRequestFeatures.md +10 -0
- package/docs/SubAccountsResponse.md +9 -0
- package/docs/SubAccountsResponseSubAccounts.md +11 -0
- package/docs/Task.md +13 -0
- package/docs/TaskList.md +8 -0
- package/docs/TaskReminder.md +25 -0
- package/docs/TaskTypes.md +9 -0
- package/docs/TasksApi.md +360 -0
- package/docs/TransactionalEmailsApi.md +1333 -0
- package/docs/TransactionalSMSApi.md +261 -0
- package/docs/TransactionalWhatsAppApi.md +137 -0
- package/docs/UpdateAttribute.md +9 -0
- package/docs/UpdateAttributeEnumeration.md +9 -0
- package/docs/UpdateBatchContacts.md +8 -0
- package/docs/UpdateBatchContactsContacts.md +17 -0
- package/docs/UpdateBatchContactsModel.md +9 -0
- package/docs/UpdateCampaignStatus.md +31 -0
- package/docs/UpdateChild.md +12 -0
- package/docs/UpdateChildAccountStatus.md +11 -0
- package/docs/UpdateChildDomain.md +8 -0
- package/docs/UpdateContact.md +14 -0
- package/docs/UpdateCouponCollection.md +8 -0
- package/docs/UpdateEmailCampaign.md +49 -0
- package/docs/UpdateEmailCampaignRecipients.md +10 -0
- package/docs/UpdateEmailCampaignSender.md +10 -0
- package/docs/UpdateExternalFeed.md +29 -0
- package/docs/UpdateList.md +9 -0
- package/docs/UpdateSender.md +10 -0
- package/docs/UpdateSmsCampaign.md +15 -0
- package/docs/UpdateSmtpTemplate.md +17 -0
- package/docs/UpdateSmtpTemplateSender.md +10 -0
- package/docs/UpdateWebhook.md +52 -0
- package/docs/UpdateWhatsAppCampaign.md +22 -0
- package/docs/UploadImageModel.md +8 -0
- package/docs/UploadImageToGallery.md +9 -0
- package/docs/UserApi.md +112 -0
- package/docs/VariablesItems.md +10 -0
- package/docs/WebhooksApi.md +346 -0
- package/docs/WhatsAppCampaignsApi.md +519 -0
- package/docs/WhatsappCampStats.md +12 -0
- package/docs/WhatsappCampTemplate.md +18 -0
- package/git_push.sh +52 -0
- package/mocha.opts +1 -0
- package/package.json +35 -0
- package/src/ApiClient.js +601 -0
- package/src/api/AccountApi.js +154 -0
- package/src/api/CompaniesApi.js +431 -0
- package/src/api/ContactsApi.js +1683 -0
- package/src/api/ConversationsApi.js +529 -0
- package/src/api/CouponsApi.js +317 -0
- package/src/api/DealsApi.js +527 -0
- package/src/api/DomainsApi.js +297 -0
- package/src/api/EcommerceApi.js +656 -0
- package/src/api/EmailCampaignsApi.js +781 -0
- package/src/api/ExternalFeedsApi.js +340 -0
- package/src/api/FilesApi.js +336 -0
- package/src/api/InboundParsingApi.js +225 -0
- package/src/api/MasterAccountApi.js +537 -0
- package/src/api/NotesApi.js +330 -0
- package/src/api/ProcessApi.js +159 -0
- package/src/api/ResellerApi.js +941 -0
- package/src/api/SMSCampaignsApi.js +612 -0
- package/src/api/SendersApi.js +410 -0
- package/src/api/TasksApi.js +391 -0
- package/src/api/TransactionalEmailsApi.js +1318 -0
- package/src/api/TransactionalSMSApi.js +295 -0
- package/src/api/TransactionalWhatsAppApi.js +177 -0
- package/src/api/UserApi.js +147 -0
- package/src/api/WebhooksApi.js +367 -0
- package/src/api/WhatsAppCampaignsApi.js +527 -0
- package/src/index.js +1833 -0
- package/src/model/AbTestCampaignResult.js +185 -0
- package/src/model/AbTestCampaignResultClickedLinks.js +83 -0
- package/src/model/AbTestCampaignResultStatistics.js +119 -0
- package/src/model/AbTestVersionClicks.js +69 -0
- package/src/model/AbTestVersionClicksInner.js +95 -0
- package/src/model/AbTestVersionStats.js +86 -0
- package/src/model/AddChildDomain.js +73 -0
- package/src/model/AddContactToList.js +81 -0
- package/src/model/AddCredits.js +81 -0
- package/src/model/AuthenticateDomainModel.js +85 -0
- package/src/model/BlockDomain.js +75 -0
- package/src/model/Body.js +91 -0
- package/src/model/Body1.js +89 -0
- package/src/model/Body10.js +101 -0
- package/src/model/Body11.js +75 -0
- package/src/model/Body12.js +97 -0
- package/src/model/Body2.js +97 -0
- package/src/model/Body3.js +83 -0
- package/src/model/Body4.js +81 -0
- package/src/model/Body5.js +97 -0
- package/src/model/Body6.js +158 -0
- package/src/model/Body7.js +145 -0
- package/src/model/Body8.js +117 -0
- package/src/model/Body9.js +75 -0
- package/src/model/BodyVariablesItems.js +65 -0
- package/src/model/CompaniesList.js +74 -0
- package/src/model/Company.js +98 -0
- package/src/model/CompanyAttributes.js +69 -0
- package/src/model/CompanyAttributesInner.js +101 -0
- package/src/model/ComponentItems.js +79 -0
- package/src/model/ConversationsMessage.js +165 -0
- package/src/model/ConversationsMessageFile.js +104 -0
- package/src/model/ConversationsMessageFileImageInfo.js +90 -0
- package/src/model/CreateApiKeyRequest.js +83 -0
- package/src/model/CreateApiKeyResponse.js +81 -0
- package/src/model/CreateAttribute.js +141 -0
- package/src/model/CreateAttributeEnumeration.js +85 -0
- package/src/model/CreateCategoryModel.js +73 -0
- package/src/model/CreateChild.js +167 -0
- package/src/model/CreateContact.js +130 -0
- package/src/model/CreateCouponCollection.js +85 -0
- package/src/model/CreateCoupons.js +84 -0
- package/src/model/CreateDoiContact.js +121 -0
- package/src/model/CreateDomain.js +75 -0
- package/src/model/CreateDomainModel.js +98 -0
- package/src/model/CreateDomainModelDnsRecords.js +79 -0
- package/src/model/CreateDomainModelDnsRecordsDkimRecord.js +93 -0
- package/src/model/CreateEmailCampaign.js +339 -0
- package/src/model/CreateEmailCampaignRecipients.js +90 -0
- package/src/model/CreateEmailCampaignSender.js +92 -0
- package/src/model/CreateExternalFeed.js +169 -0
- package/src/model/CreateList.js +85 -0
- package/src/model/CreateModel.js +75 -0
- package/src/model/CreateProductModel.js +73 -0
- package/src/model/CreateReseller.js +83 -0
- package/src/model/CreateSender.js +93 -0
- package/src/model/CreateSenderIps.js +93 -0
- package/src/model/CreateSenderModel.js +91 -0
- package/src/model/CreateSmsCampaign.js +135 -0
- package/src/model/CreateSmsCampaignRecipients.js +83 -0
- package/src/model/CreateSmtpEmail.js +80 -0
- package/src/model/CreateSmtpTemplate.js +150 -0
- package/src/model/CreateSmtpTemplateSender.js +90 -0
- package/src/model/CreateSubAccount.js +145 -0
- package/src/model/CreateSubAccountResponse.js +75 -0
- package/src/model/CreateUpdateBatchCategory.js +83 -0
- package/src/model/CreateUpdateBatchCategoryModel.js +81 -0
- package/src/model/CreateUpdateBatchProducts.js +83 -0
- package/src/model/CreateUpdateBatchProductsModel.js +81 -0
- package/src/model/CreateUpdateCategories.js +99 -0
- package/src/model/CreateUpdateCategory.js +108 -0
- package/src/model/CreateUpdateContactModel.js +73 -0
- package/src/model/CreateUpdateFolder.js +73 -0
- package/src/model/CreateUpdateProduct.js +158 -0
- package/src/model/CreateUpdateProducts.js +149 -0
- package/src/model/CreateWebhook.js +246 -0
- package/src/model/CreateWhatsAppCampaign.js +104 -0
- package/src/model/CreateWhatsAppCampaignRecipients.js +90 -0
- package/src/model/CreateWhatsAppTemplate.js +141 -0
- package/src/model/CreatedBatchId.js +75 -0
- package/src/model/CreatedProcessId.js +75 -0
- package/src/model/Deal.js +98 -0
- package/src/model/DealAttributes.js +69 -0
- package/src/model/DealAttributesInner.js +101 -0
- package/src/model/DealsList.js +74 -0
- package/src/model/DeleteHardbounces.js +89 -0
- package/src/model/EmailExportRecipients.js +139 -0
- package/src/model/ErrorModel.js +189 -0
- package/src/model/ExportWebhooksHistory.js +251 -0
- package/src/model/FileData.js +122 -0
- package/src/model/FileDownloadableLink.js +75 -0
- package/src/model/FileList.js +69 -0
- package/src/model/GetAccount.js +101 -0
- package/src/model/GetAccountActivity.js +73 -0
- package/src/model/GetAccountActivityLogs.js +115 -0
- package/src/model/GetAccountMarketingAutomation.js +83 -0
- package/src/model/GetAccountPlan.js +171 -0
- package/src/model/GetAccountRelay.js +85 -0
- package/src/model/GetAccountRelayData.js +96 -0
- package/src/model/GetAggregatedReport.js +169 -0
- package/src/model/GetAllExternalFeeds.js +80 -0
- package/src/model/GetAllExternalFeedsFeeds.js +205 -0
- package/src/model/GetAttributes.js +75 -0
- package/src/model/GetAttributesAttributes.js +185 -0
- package/src/model/GetAttributesEnumeration.js +85 -0
- package/src/model/GetBlockedDomains.js +76 -0
- package/src/model/GetCampaignOverview.js +249 -0
- package/src/model/GetCampaignRecipients.js +83 -0
- package/src/model/GetCampaignStats.js +215 -0
- package/src/model/GetCategories.js +84 -0
- package/src/model/GetCategoryDetails.js +121 -0
- package/src/model/GetChildAccountCreationStatus.js +75 -0
- package/src/model/GetChildDomain.js +81 -0
- package/src/model/GetChildDomains.js +68 -0
- package/src/model/GetChildInfo.js +113 -0
- package/src/model/GetChildInfoApiKeys.js +82 -0
- package/src/model/GetChildInfoApiKeysV2.js +85 -0
- package/src/model/GetChildInfoApiKeysV3.js +85 -0
- package/src/model/GetChildInfoCredits.js +82 -0
- package/src/model/GetChildInfoStatistics.js +90 -0
- package/src/model/GetChildrenList.js +81 -0
- package/src/model/GetClient.js +105 -0
- package/src/model/GetContactCampaignStats.js +129 -0
- package/src/model/GetContactCampaignStatsClicked.js +84 -0
- package/src/model/GetContactCampaignStatsOpened.js +105 -0
- package/src/model/GetContactCampaignStatsTransacAttributes.js +95 -0
- package/src/model/GetContactCampaignStatsUnsubscriptions.js +85 -0
- package/src/model/GetContactDetails.js +151 -0
- package/src/model/GetContacts.js +84 -0
- package/src/model/GetCouponCollection.js +125 -0
- package/src/model/GetDeviceBrowserStats.js +105 -0
- package/src/model/GetDomainConfigurationModel.js +104 -0
- package/src/model/GetDomainsList.js +73 -0
- package/src/model/GetDomainsListDomains.js +113 -0
- package/src/model/GetEmailCampaign.js +100 -0
- package/src/model/GetEmailCampaigns.js +80 -0
- package/src/model/GetEmailEventReport.js +72 -0
- package/src/model/GetEmailEventReportEvents.js +253 -0
- package/src/model/GetExtendedCampaignOverview.js +217 -0
- package/src/model/GetExtendedCampaignOverviewSender.js +89 -0
- package/src/model/GetExtendedCampaignStats.js +143 -0
- package/src/model/GetExtendedCampaignStatsGlobalStats.js +66 -0
- package/src/model/GetExtendedClient.js +83 -0
- package/src/model/GetExtendedClientAddress.js +106 -0
- package/src/model/GetExtendedContactDetails.js +87 -0
- package/src/model/GetExtendedContactDetailsStatistics.js +137 -0
- package/src/model/GetExtendedContactDetailsStatisticsClicked.js +85 -0
- package/src/model/GetExtendedContactDetailsStatisticsLinks.js +105 -0
- package/src/model/GetExtendedContactDetailsStatisticsMessagesSent.js +85 -0
- package/src/model/GetExtendedContactDetailsStatisticsOpened.js +105 -0
- package/src/model/GetExtendedContactDetailsStatisticsUnsubscriptions.js +86 -0
- package/src/model/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.js +83 -0
- package/src/model/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.js +93 -0
- package/src/model/GetExtendedList.js +110 -0
- package/src/model/GetExtendedListCampaignStats.js +84 -0
- package/src/model/GetExternalFeedByUUID.js +205 -0
- package/src/model/GetExternalFeedByUUIDHeaders.js +81 -0
- package/src/model/GetFolder.js +115 -0
- package/src/model/GetFolderLists.js +80 -0
- package/src/model/GetFolders.js +80 -0
- package/src/model/GetInboundEmailEvents.js +72 -0
- package/src/model/GetInboundEmailEventsByUuid.js +129 -0
- package/src/model/GetInboundEmailEventsByUuidAttachments.js +97 -0
- package/src/model/GetInboundEmailEventsByUuidLogs.js +113 -0
- package/src/model/GetInboundEmailEventsEvents.js +105 -0
- package/src/model/GetInvitedUsersList.js +73 -0
- package/src/model/GetInvitedUsersListFeatureAccess.js +90 -0
- package/src/model/GetInvitedUsersListUsers.js +104 -0
- package/src/model/GetIp.js +105 -0
- package/src/model/GetIpFromSender.js +105 -0
- package/src/model/GetIps.js +75 -0
- package/src/model/GetIpsFromSender.js +75 -0
- package/src/model/GetList.js +115 -0
- package/src/model/GetLists.js +81 -0
- package/src/model/GetProcess.js +129 -0
- package/src/model/GetProcesses.js +81 -0
- package/src/model/GetProductDetails.js +197 -0
- package/src/model/GetProducts.js +84 -0
- package/src/model/GetReports.js +72 -0
- package/src/model/GetReportsReports.js +195 -0
- package/src/model/GetScheduledEmailByBatchId.js +80 -0
- package/src/model/GetScheduledEmailByBatchIdBatches.js +127 -0
- package/src/model/GetScheduledEmailByMessageId.js +127 -0
- package/src/model/GetSegments.js +80 -0
- package/src/model/GetSegmentsSegments.js +97 -0
- package/src/model/GetSendersList.js +73 -0
- package/src/model/GetSendersListIps.js +95 -0
- package/src/model/GetSendersListSenders.js +113 -0
- package/src/model/GetSharedTemplateUrl.js +75 -0
- package/src/model/GetSmsCampaign.js +95 -0
- package/src/model/GetSmsCampaignOverview.js +187 -0
- package/src/model/GetSmsCampaignRecipients.js +65 -0
- package/src/model/GetSmsCampaignStats.js +135 -0
- package/src/model/GetSmsCampaigns.js +80 -0
- package/src/model/GetSmsEventReport.js +72 -0
- package/src/model/GetSmsEventReportEvents.js +188 -0
- package/src/model/GetSmtpTemplateOverview.js +192 -0
- package/src/model/GetSmtpTemplateOverviewSender.js +89 -0
- package/src/model/GetSmtpTemplates.js +80 -0
- package/src/model/GetSsoToken.js +75 -0
- package/src/model/GetStatsByBrowser.js +68 -0
- package/src/model/GetStatsByDevice.js +97 -0
- package/src/model/GetStatsByDomain.js +68 -0
- package/src/model/GetTransacAggregatedSmsReport.js +145 -0
- package/src/model/GetTransacBlockedContacts.js +80 -0
- package/src/model/GetTransacBlockedContactsContacts.js +104 -0
- package/src/model/GetTransacBlockedContactsReason.js +126 -0
- package/src/model/GetTransacEmailContent.js +133 -0
- package/src/model/GetTransacEmailContentEvents.js +85 -0
- package/src/model/GetTransacEmailsList.js +80 -0
- package/src/model/GetTransacEmailsListTransactionalEmails.js +139 -0
- package/src/model/GetTransacSmsReport.js +72 -0
- package/src/model/GetTransacSmsReportReports.js +145 -0
- package/src/model/GetUserPermission.js +96 -0
- package/src/model/GetUserPermissionPrivileges.js +83 -0
- package/src/model/GetWATemplates.js +84 -0
- package/src/model/GetWATemplatesTemplates.js +143 -0
- package/src/model/GetWebhook.js +154 -0
- package/src/model/GetWebhooks.js +74 -0
- package/src/model/GetWhatsAppConfig.js +165 -0
- package/src/model/GetWhatsappCampaignOverview.js +205 -0
- package/src/model/GetWhatsappCampaigns.js +80 -0
- package/src/model/GetWhatsappCampaignsCampaigns.js +222 -0
- package/src/model/GetWhatsappEventReport.js +72 -0
- package/src/model/GetWhatsappEventReportEvents.js +189 -0
- package/src/model/InlineResponse200.js +76 -0
- package/src/model/InlineResponse2001.js +95 -0
- package/src/model/InlineResponse201.js +76 -0
- package/src/model/InlineResponse2011.js +76 -0
- package/src/model/InlineResponse2012.js +75 -0
- package/src/model/InlineResponse2013.js +75 -0
- package/src/model/InlineResponse2014.js +75 -0
- package/src/model/ManageIp.js +73 -0
- package/src/model/MasterDetailsResponse.js +119 -0
- package/src/model/MasterDetailsResponseBillingInfo.js +96 -0
- package/src/model/MasterDetailsResponseBillingInfoAddress.js +106 -0
- package/src/model/MasterDetailsResponseBillingInfoName.js +82 -0
- package/src/model/MasterDetailsResponsePlanInfo.js +134 -0
- package/src/model/MasterDetailsResponsePlanInfoFeatures.js +105 -0
- package/src/model/Note.js +124 -0
- package/src/model/NoteData.js +100 -0
- package/src/model/NoteId.js +74 -0
- package/src/model/NoteList.js +69 -0
- package/src/model/Order.js +147 -0
- package/src/model/OrderBatch.js +83 -0
- package/src/model/OrderBilling.js +122 -0
- package/src/model/OrderProducts.js +104 -0
- package/src/model/Otp.js +73 -0
- package/src/model/Pipeline.js +90 -0
- package/src/model/PipelineStage.js +82 -0
- package/src/model/Pipelines.js +69 -0
- package/src/model/PostContactInfo.js +74 -0
- package/src/model/PostContactInfoContacts.js +95 -0
- package/src/model/PostSendFailed.js +106 -0
- package/src/model/PostSendSmsTestFailed.js +99 -0
- package/src/model/RemainingCreditModel.js +83 -0
- package/src/model/RemainingCreditModelChild.js +86 -0
- package/src/model/RemainingCreditModelReseller.js +85 -0
- package/src/model/RemoveContactFromList.js +89 -0
- package/src/model/RemoveCredits.js +81 -0
- package/src/model/RequestContactExport.js +90 -0
- package/src/model/RequestContactExportCustomContactFilter.js +222 -0
- package/src/model/RequestContactImport.js +148 -0
- package/src/model/RequestContactImportNewList.js +82 -0
- package/src/model/RequestSmsRecipientExport.js +127 -0
- package/src/model/ScheduleSmtpEmail.js +88 -0
- package/src/model/SendReport.js +127 -0
- package/src/model/SendReportEmail.js +86 -0
- package/src/model/SendSms.js +107 -0
- package/src/model/SendSmtpEmail.js +191 -0
- package/src/model/SendSmtpEmailAttachment.js +89 -0
- package/src/model/SendSmtpEmailBcc.js +83 -0
- package/src/model/SendSmtpEmailCc.js +83 -0
- package/src/model/SendSmtpEmailMessageVersions.js +114 -0
- package/src/model/SendSmtpEmailReplyTo.js +84 -0
- package/src/model/SendSmtpEmailReplyTo1.js +84 -0
- package/src/model/SendSmtpEmailSender.js +90 -0
- package/src/model/SendSmtpEmailTo.js +83 -0
- package/src/model/SendSmtpEmailTo1.js +83 -0
- package/src/model/SendTestEmail.js +73 -0
- package/src/model/SendTestSms.js +73 -0
- package/src/model/SendTransacSms.js +157 -0
- package/src/model/SendWhatsappMessage.js +101 -0
- package/src/model/SsoTokenRequest.js +147 -0
- package/src/model/SubAccountDetailsResponse.js +96 -0
- package/src/model/SubAccountDetailsResponsePlanInfo.js +88 -0
- package/src/model/SubAccountDetailsResponsePlanInfoCredits.js +81 -0
- package/src/model/SubAccountDetailsResponsePlanInfoCreditsEmails.js +82 -0
- package/src/model/SubAccountDetailsResponsePlanInfoFeatures.js +87 -0
- package/src/model/SubAccountDetailsResponsePlanInfoFeaturesInbox.js +82 -0
- package/src/model/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.js +82 -0
- package/src/model/SubAccountDetailsResponsePlanInfoFeaturesUsers.js +82 -0
- package/src/model/SubAccountUpdatePlanRequest.js +80 -0
- package/src/model/SubAccountUpdatePlanRequestCredits.js +74 -0
- package/src/model/SubAccountUpdatePlanRequestFeatures.js +90 -0
- package/src/model/SubAccountsResponse.js +80 -0
- package/src/model/SubAccountsResponseSubAccounts.js +105 -0
- package/src/model/Task.js +118 -0
- package/src/model/TaskList.js +74 -0
- package/src/model/TaskReminder.js +128 -0
- package/src/model/TaskTypes.js +82 -0
- package/src/model/UpdateAttribute.js +81 -0
- package/src/model/UpdateAttributeEnumeration.js +85 -0
- package/src/model/UpdateBatchContacts.js +73 -0
- package/src/model/UpdateBatchContactsContacts.js +145 -0
- package/src/model/UpdateBatchContactsModel.js +79 -0
- package/src/model/UpdateCampaignStatus.js +130 -0
- package/src/model/UpdateChild.js +105 -0
- package/src/model/UpdateChildAccountStatus.js +97 -0
- package/src/model/UpdateChildDomain.js +73 -0
- package/src/model/UpdateContact.js +121 -0
- package/src/model/UpdateCouponCollection.js +75 -0
- package/src/model/UpdateEmailCampaign.js +335 -0
- package/src/model/UpdateEmailCampaignRecipients.js +90 -0
- package/src/model/UpdateEmailCampaignSender.js +90 -0
- package/src/model/UpdateExternalFeed.js +164 -0
- package/src/model/UpdateList.js +81 -0
- package/src/model/UpdateSender.js +89 -0
- package/src/model/UpdateSmsCampaign.js +129 -0
- package/src/model/UpdateSmtpTemplate.js +144 -0
- package/src/model/UpdateSmtpTemplateSender.js +90 -0
- package/src/model/UpdateWebhook.js +207 -0
- package/src/model/UpdateWhatsAppCampaign.js +117 -0
- package/src/model/UploadImageModel.js +75 -0
- package/src/model/UploadImageToGallery.js +83 -0
- package/src/model/VariablesItems.js +86 -0
- package/src/model/WhatsappCampStats.js +110 -0
- package/src/model/WhatsappCampTemplate.js +149 -0
- package/test/api/AccountApi.spec.js +157 -0
- package/test/api/CompaniesApi.spec.js +273 -0
- package/test/api/ContactsApi.spec.js +1278 -0
- package/test/api/ConversationsApi.spec.js +430 -0
- package/test/api/CouponsApi.spec.js +176 -0
- package/test/api/DealsApi.spec.js +300 -0
- package/test/api/DomainsApi.spec.js +210 -0
- package/test/api/EcommerceApi.spec.js +423 -0
- package/test/api/EmailCampaignsApi.spec.js +512 -0
- package/test/api/ExternalFeedsApi.spec.js +249 -0
- package/test/api/FilesApi.spec.js +176 -0
- package/test/api/InboundParsingApi.spec.js +168 -0
- package/test/api/MasterAccountApi.spec.js +372 -0
- package/test/api/NotesApi.spec.js +181 -0
- package/test/api/ProcessApi.spec.js +111 -0
- package/test/api/ResellerApi.spec.js +467 -0
- package/test/api/SMSCampaignsApi.spec.js +294 -0
- package/test/api/SendersApi.spec.js +264 -0
- package/test/api/TasksApi.spec.js +277 -0
- package/test/api/TransactionalEmailsApi.spec.js +870 -0
- package/test/api/TransactionalSMSApi.spec.js +228 -0
- package/test/api/TransactionalWhatsAppApi.spec.js +120 -0
- package/test/api/UserApi.spec.js +128 -0
- package/test/api/WebhooksApi.spec.js +209 -0
- package/test/api/WhatsAppCampaignsApi.spec.js +413 -0
- package/test/assert-equals.js +81 -0
- package/test/model/AbTestCampaignResult.spec.js +95 -0
- package/test/model/AbTestCampaignResultClickedLinks.spec.js +59 -0
- package/test/model/AbTestCampaignResultStatistics.spec.js +83 -0
- package/test/model/AbTestVersionClicks.spec.js +47 -0
- package/test/model/AbTestVersionClicksInner.spec.js +65 -0
- package/test/model/AbTestVersionStats.spec.js +59 -0
- package/test/model/AddChildDomain.spec.js +53 -0
- package/test/model/AddContactToList.spec.js +59 -0
- package/test/model/AddCredits.spec.js +59 -0
- package/test/model/AuthenticateDomainModel.spec.js +59 -0
- package/test/model/BlockDomain.spec.js +53 -0
- package/test/model/Body.spec.js +65 -0
- package/test/model/Body1.spec.js +65 -0
- package/test/model/Body10.spec.js +71 -0
- package/test/model/Body11.spec.js +53 -0
- package/test/model/Body12.spec.js +71 -0
- package/test/model/Body2.spec.js +71 -0
- package/test/model/Body3.spec.js +59 -0
- package/test/model/Body4.spec.js +59 -0
- package/test/model/Body5.spec.js +71 -0
- package/test/model/Body6.spec.js +113 -0
- package/test/model/Body7.spec.js +107 -0
- package/test/model/Body8.spec.js +83 -0
- package/test/model/Body9.spec.js +53 -0
- package/test/model/BodyVariablesItems.spec.js +47 -0
- package/test/model/CompaniesList.spec.js +53 -0
- package/test/model/Company.spec.js +71 -0
- package/test/model/CompanyAttributes.spec.js +47 -0
- package/test/model/CompanyAttributesInner.spec.js +77 -0
- package/test/model/ComponentItems.spec.js +59 -0
- package/test/model/ConversationsMessage.spec.js +107 -0
- package/test/model/ConversationsMessageFile.spec.js +77 -0
- package/test/model/ConversationsMessageFileImageInfo.spec.js +65 -0
- package/test/model/CreateApiKeyRequest.spec.js +59 -0
- package/test/model/CreateApiKeyResponse.spec.js +59 -0
- package/test/model/CreateAttribute.spec.js +71 -0
- package/test/model/CreateAttributeEnumeration.spec.js +59 -0
- package/test/model/CreateCategoryModel.spec.js +53 -0
- package/test/model/CreateChild.spec.js +83 -0
- package/test/model/CreateContact.spec.js +95 -0
- package/test/model/CreateCouponCollection.spec.js +59 -0
- package/test/model/CreateCoupons.spec.js +59 -0
- package/test/model/CreateDoiContact.spec.js +83 -0
- package/test/model/CreateDomain.spec.js +53 -0
- package/test/model/CreateDomainModel.spec.js +71 -0
- package/test/model/CreateDomainModelDnsRecords.spec.js +59 -0
- package/test/model/CreateDomainModelDnsRecordsDkimRecord.spec.js +71 -0
- package/test/model/CreateEmailCampaign.spec.js +233 -0
- package/test/model/CreateEmailCampaignRecipients.spec.js +65 -0
- package/test/model/CreateEmailCampaignSender.spec.js +65 -0
- package/test/model/CreateExternalFeed.spec.js +101 -0
- package/test/model/CreateList.spec.js +59 -0
- package/test/model/CreateModel.spec.js +53 -0
- package/test/model/CreateProductModel.spec.js +53 -0
- package/test/model/CreateReseller.spec.js +59 -0
- package/test/model/CreateSender.spec.js +65 -0
- package/test/model/CreateSenderIps.spec.js +65 -0
- package/test/model/CreateSenderModel.spec.js +65 -0
- package/test/model/CreateSmsCampaign.spec.js +95 -0
- package/test/model/CreateSmsCampaignRecipients.spec.js +59 -0
- package/test/model/CreateSmtpEmail.spec.js +59 -0
- package/test/model/CreateSmtpTemplate.spec.js +107 -0
- package/test/model/CreateSmtpTemplateSender.spec.js +65 -0
- package/test/model/CreateSubAccount.spec.js +71 -0
- package/test/model/CreateSubAccountResponse.spec.js +53 -0
- package/test/model/CreateUpdateBatchCategory.spec.js +59 -0
- package/test/model/CreateUpdateBatchCategoryModel.spec.js +59 -0
- package/test/model/CreateUpdateBatchProducts.spec.js +59 -0
- package/test/model/CreateUpdateBatchProductsModel.spec.js +59 -0
- package/test/model/CreateUpdateCategories.spec.js +71 -0
- package/test/model/CreateUpdateCategory.spec.js +77 -0
- package/test/model/CreateUpdateContactModel.spec.js +53 -0
- package/test/model/CreateUpdateFolder.spec.js +53 -0
- package/test/model/CreateUpdateProduct.spec.js +113 -0
- package/test/model/CreateUpdateProducts.spec.js +107 -0
- package/test/model/CreateWebhook.spec.js +77 -0
- package/test/model/CreateWhatsAppCampaign.spec.js +71 -0
- package/test/model/CreateWhatsAppCampaignRecipients.spec.js +65 -0
- package/test/model/CreateWhatsAppTemplate.spec.js +83 -0
- package/test/model/CreatedBatchId.spec.js +53 -0
- package/test/model/CreatedProcessId.spec.js +53 -0
- package/test/model/Deal.spec.js +71 -0
- package/test/model/DealAttributes.spec.js +47 -0
- package/test/model/DealAttributesInner.spec.js +77 -0
- package/test/model/DealsList.spec.js +53 -0
- package/test/model/DeleteHardbounces.spec.js +65 -0
- package/test/model/EmailExportRecipients.spec.js +59 -0
- package/test/model/ErrorModel.spec.js +59 -0
- package/test/model/ExportWebhooksHistory.spec.js +101 -0
- package/test/model/FileData.spec.js +89 -0
- package/test/model/FileDownloadableLink.spec.js +53 -0
- package/test/model/FileList.spec.js +47 -0
- package/test/model/GetAccount.spec.js +65 -0
- package/test/model/GetAccountActivity.spec.js +53 -0
- package/test/model/GetAccountActivityLogs.spec.js +77 -0
- package/test/model/GetAccountMarketingAutomation.spec.js +59 -0
- package/test/model/GetAccountPlan.spec.js +83 -0
- package/test/model/GetAccountRelay.spec.js +59 -0
- package/test/model/GetAccountRelayData.spec.js +65 -0
- package/test/model/GetAggregatedReport.spec.js +125 -0
- package/test/model/GetAllExternalFeeds.spec.js +59 -0
- package/test/model/GetAllExternalFeedsFeeds.spec.js +119 -0
- package/test/model/GetAttributes.spec.js +53 -0
- package/test/model/GetAttributesAttributes.spec.js +77 -0
- package/test/model/GetAttributesEnumeration.spec.js +59 -0
- package/test/model/GetBlockedDomains.spec.js +53 -0
- package/test/model/GetCampaignOverview.spec.js +131 -0
- package/test/model/GetCampaignRecipients.spec.js +59 -0
- package/test/model/GetCampaignStats.spec.js +143 -0
- package/test/model/GetCategories.spec.js +59 -0
- package/test/model/GetCategoryDetails.spec.js +83 -0
- package/test/model/GetChildAccountCreationStatus.spec.js +53 -0
- package/test/model/GetChildDomain.spec.js +59 -0
- package/test/model/GetChildDomains.spec.js +47 -0
- package/test/model/GetChildInfo.spec.js +77 -0
- package/test/model/GetChildInfoApiKeys.spec.js +59 -0
- package/test/model/GetChildInfoApiKeysV2.spec.js +59 -0
- package/test/model/GetChildInfoApiKeysV3.spec.js +59 -0
- package/test/model/GetChildInfoCredits.spec.js +59 -0
- package/test/model/GetChildInfoStatistics.spec.js +65 -0
- package/test/model/GetChildrenList.spec.js +59 -0
- package/test/model/GetClient.spec.js +71 -0
- package/test/model/GetContactCampaignStats.spec.js +101 -0
- package/test/model/GetContactCampaignStatsClicked.spec.js +59 -0
- package/test/model/GetContactCampaignStatsOpened.spec.js +71 -0
- package/test/model/GetContactCampaignStatsTransacAttributes.spec.js +65 -0
- package/test/model/GetContactCampaignStatsUnsubscriptions.spec.js +59 -0
- package/test/model/GetContactDetails.spec.js +101 -0
- package/test/model/GetContacts.spec.js +59 -0
- package/test/model/GetCouponCollection.spec.js +83 -0
- package/test/model/GetDeviceBrowserStats.spec.js +71 -0
- package/test/model/GetDomainConfigurationModel.spec.js +71 -0
- package/test/model/GetDomainsList.spec.js +53 -0
- package/test/model/GetDomainsListDomains.spec.js +77 -0
- package/test/model/GetEmailCampaign.spec.js +59 -0
- package/test/model/GetEmailCampaigns.spec.js +59 -0
- package/test/model/GetEmailEventReport.spec.js +53 -0
- package/test/model/GetEmailEventReportEvents.spec.js +113 -0
- package/test/model/GetExtendedCampaignOverview.spec.js +143 -0
- package/test/model/GetExtendedCampaignOverviewSender.spec.js +65 -0
- package/test/model/GetExtendedCampaignStats.spec.js +95 -0
- package/test/model/GetExtendedCampaignStatsGlobalStats.spec.js +47 -0
- package/test/model/GetExtendedClient.spec.js +53 -0
- package/test/model/GetExtendedClientAddress.spec.js +71 -0
- package/test/model/GetExtendedContactDetails.spec.js +53 -0
- package/test/model/GetExtendedContactDetailsStatistics.spec.js +101 -0
- package/test/model/GetExtendedContactDetailsStatisticsClicked.spec.js +59 -0
- package/test/model/GetExtendedContactDetailsStatisticsLinks.spec.js +71 -0
- package/test/model/GetExtendedContactDetailsStatisticsMessagesSent.spec.js +59 -0
- package/test/model/GetExtendedContactDetailsStatisticsOpened.spec.js +71 -0
- package/test/model/GetExtendedContactDetailsStatisticsUnsubscriptions.spec.js +59 -0
- package/test/model/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.spec.js +59 -0
- package/test/model/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.spec.js +65 -0
- package/test/model/GetExtendedList.spec.js +71 -0
- package/test/model/GetExtendedListCampaignStats.spec.js +59 -0
- package/test/model/GetExternalFeedByUUID.spec.js +119 -0
- package/test/model/GetExternalFeedByUUIDHeaders.spec.js +59 -0
- package/test/model/GetFolder.spec.js +77 -0
- package/test/model/GetFolderLists.spec.js +59 -0
- package/test/model/GetFolders.spec.js +59 -0
- package/test/model/GetInboundEmailEvents.spec.js +53 -0
- package/test/model/GetInboundEmailEventsByUuid.spec.js +95 -0
- package/test/model/GetInboundEmailEventsByUuidAttachments.spec.js +71 -0
- package/test/model/GetInboundEmailEventsByUuidLogs.spec.js +59 -0
- package/test/model/GetInboundEmailEventsEvents.spec.js +71 -0
- package/test/model/GetInvitedUsersList.spec.js +53 -0
- package/test/model/GetInvitedUsersListFeatureAccess.spec.js +65 -0
- package/test/model/GetInvitedUsersListUsers.spec.js +71 -0
- package/test/model/GetIp.spec.js +71 -0
- package/test/model/GetIpFromSender.spec.js +71 -0
- package/test/model/GetIps.spec.js +53 -0
- package/test/model/GetIpsFromSender.spec.js +53 -0
- package/test/model/GetList.spec.js +77 -0
- package/test/model/GetLists.spec.js +59 -0
- package/test/model/GetProcess.spec.js +71 -0
- package/test/model/GetProcesses.spec.js +59 -0
- package/test/model/GetProductDetails.spec.js +137 -0
- package/test/model/GetProducts.spec.js +59 -0
- package/test/model/GetReports.spec.js +53 -0
- package/test/model/GetReportsReports.spec.js +125 -0
- package/test/model/GetScheduledEmailByBatchId.spec.js +59 -0
- package/test/model/GetScheduledEmailByBatchIdBatches.spec.js +65 -0
- package/test/model/GetScheduledEmailByMessageId.spec.js +65 -0
- package/test/model/GetSegments.spec.js +59 -0
- package/test/model/GetSegmentsSegments.spec.js +71 -0
- package/test/model/GetSendersList.spec.js +53 -0
- package/test/model/GetSendersListIps.spec.js +65 -0
- package/test/model/GetSendersListSenders.spec.js +77 -0
- package/test/model/GetSharedTemplateUrl.spec.js +53 -0
- package/test/model/GetSmsCampaign.spec.js +59 -0
- package/test/model/GetSmsCampaignOverview.spec.js +95 -0
- package/test/model/GetSmsCampaignRecipients.spec.js +47 -0
- package/test/model/GetSmsCampaignStats.spec.js +89 -0
- package/test/model/GetSmsCampaigns.spec.js +59 -0
- package/test/model/GetSmsEventReport.spec.js +53 -0
- package/test/model/GetSmsEventReportEvents.spec.js +89 -0
- package/test/model/GetSmtpTemplateOverview.spec.js +125 -0
- package/test/model/GetSmtpTemplateOverviewSender.spec.js +65 -0
- package/test/model/GetSmtpTemplates.spec.js +59 -0
- package/test/model/GetSsoToken.spec.js +53 -0
- package/test/model/GetStatsByBrowser.spec.js +47 -0
- package/test/model/GetStatsByDevice.spec.js +71 -0
- package/test/model/GetStatsByDomain.spec.js +47 -0
- package/test/model/GetTransacAggregatedSmsReport.spec.js +107 -0
- package/test/model/GetTransacBlockedContacts.spec.js +59 -0
- package/test/model/GetTransacBlockedContactsContacts.spec.js +71 -0
- package/test/model/GetTransacBlockedContactsReason.spec.js +59 -0
- package/test/model/GetTransacEmailContent.spec.js +89 -0
- package/test/model/GetTransacEmailContentEvents.spec.js +59 -0
- package/test/model/GetTransacEmailsList.spec.js +59 -0
- package/test/model/GetTransacEmailsListTransactionalEmails.spec.js +95 -0
- package/test/model/GetTransacSmsReport.spec.js +53 -0
- package/test/model/GetTransacSmsReportReports.spec.js +107 -0
- package/test/model/GetUserPermission.spec.js +65 -0
- package/test/model/GetUserPermissionPrivileges.spec.js +59 -0
- package/test/model/GetWATemplates.spec.js +59 -0
- package/test/model/GetWATemplatesTemplates.spec.js +95 -0
- package/test/model/GetWebhook.spec.js +89 -0
- package/test/model/GetWebhooks.spec.js +53 -0
- package/test/model/GetWhatsAppConfig.spec.js +83 -0
- package/test/model/GetWhatsappCampaignOverview.spec.js +101 -0
- package/test/model/GetWhatsappCampaigns.spec.js +59 -0
- package/test/model/GetWhatsappCampaignsCampaigns.spec.js +113 -0
- package/test/model/GetWhatsappEventReport.spec.js +53 -0
- package/test/model/GetWhatsappEventReportEvents.spec.js +95 -0
- package/test/model/InlineResponse200.spec.js +53 -0
- package/test/model/InlineResponse2001.spec.js +65 -0
- package/test/model/InlineResponse201.spec.js +53 -0
- package/test/model/InlineResponse2011.spec.js +53 -0
- package/test/model/InlineResponse2012.spec.js +53 -0
- package/test/model/InlineResponse2013.spec.js +53 -0
- package/test/model/InlineResponse2014.spec.js +53 -0
- package/test/model/ManageIp.spec.js +53 -0
- package/test/model/MasterDetailsResponse.spec.js +89 -0
- package/test/model/MasterDetailsResponseBillingInfo.spec.js +71 -0
- package/test/model/MasterDetailsResponseBillingInfoAddress.spec.js +77 -0
- package/test/model/MasterDetailsResponseBillingInfoName.spec.js +59 -0
- package/test/model/MasterDetailsResponsePlanInfo.spec.js +83 -0
- package/test/model/MasterDetailsResponsePlanInfoFeatures.spec.js +77 -0
- package/test/model/Note.spec.js +89 -0
- package/test/model/NoteData.spec.js +71 -0
- package/test/model/NoteId.spec.js +53 -0
- package/test/model/NoteList.spec.js +47 -0
- package/test/model/Order.spec.js +101 -0
- package/test/model/OrderBatch.spec.js +59 -0
- package/test/model/OrderBilling.spec.js +89 -0
- package/test/model/OrderProducts.spec.js +71 -0
- package/test/model/Otp.spec.js +53 -0
- package/test/model/Pipeline.spec.js +65 -0
- package/test/model/PipelineStage.spec.js +59 -0
- package/test/model/Pipelines.spec.js +47 -0
- package/test/model/PostContactInfo.spec.js +53 -0
- package/test/model/PostContactInfoContacts.spec.js +71 -0
- package/test/model/PostSendFailed.spec.js +77 -0
- package/test/model/PostSendSmsTestFailed.spec.js +71 -0
- package/test/model/RemainingCreditModel.spec.js +59 -0
- package/test/model/RemainingCreditModelChild.spec.js +59 -0
- package/test/model/RemainingCreditModelReseller.spec.js +59 -0
- package/test/model/RemoveContactFromList.spec.js +65 -0
- package/test/model/RemoveCredits.spec.js +59 -0
- package/test/model/RequestContactExport.spec.js +65 -0
- package/test/model/RequestContactExportCustomContactFilter.spec.js +83 -0
- package/test/model/RequestContactImport.spec.js +107 -0
- package/test/model/RequestContactImportNewList.spec.js +59 -0
- package/test/model/RequestSmsRecipientExport.spec.js +59 -0
- package/test/model/ScheduleSmtpEmail.spec.js +65 -0
- package/test/model/SendReport.spec.js +59 -0
- package/test/model/SendReportEmail.spec.js +59 -0
- package/test/model/SendSms.spec.js +77 -0
- package/test/model/SendSmtpEmail.spec.js +143 -0
- package/test/model/SendSmtpEmailAttachment.spec.js +65 -0
- package/test/model/SendSmtpEmailBcc.spec.js +59 -0
- package/test/model/SendSmtpEmailCc.spec.js +59 -0
- package/test/model/SendSmtpEmailMessageVersions.spec.js +83 -0
- package/test/model/SendSmtpEmailReplyTo.spec.js +59 -0
- package/test/model/SendSmtpEmailReplyTo1.spec.js +59 -0
- package/test/model/SendSmtpEmailSender.spec.js +65 -0
- package/test/model/SendSmtpEmailTo.spec.js +59 -0
- package/test/model/SendSmtpEmailTo1.spec.js +59 -0
- package/test/model/SendTestEmail.spec.js +53 -0
- package/test/model/SendTestSms.spec.js +53 -0
- package/test/model/SendTransacSms.spec.js +95 -0
- package/test/model/SendWhatsappMessage.spec.js +71 -0
- package/test/model/SsoTokenRequest.spec.js +65 -0
- package/test/model/SubAccountDetailsResponse.spec.js +71 -0
- package/test/model/SubAccountDetailsResponsePlanInfo.spec.js +65 -0
- package/test/model/SubAccountDetailsResponsePlanInfoCredits.spec.js +59 -0
- package/test/model/SubAccountDetailsResponsePlanInfoCreditsEmails.spec.js +59 -0
- package/test/model/SubAccountDetailsResponsePlanInfoFeatures.spec.js +65 -0
- package/test/model/SubAccountDetailsResponsePlanInfoFeaturesInbox.spec.js +59 -0
- package/test/model/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.spec.js +59 -0
- package/test/model/SubAccountDetailsResponsePlanInfoFeaturesUsers.spec.js +59 -0
- package/test/model/SubAccountUpdatePlanRequest.spec.js +59 -0
- package/test/model/SubAccountUpdatePlanRequestCredits.spec.js +53 -0
- package/test/model/SubAccountUpdatePlanRequestFeatures.spec.js +65 -0
- package/test/model/SubAccountsResponse.spec.js +59 -0
- package/test/model/SubAccountsResponseSubAccounts.spec.js +71 -0
- package/test/model/Task.spec.js +83 -0
- package/test/model/TaskList.spec.js +53 -0
- package/test/model/TaskReminder.spec.js +65 -0
- package/test/model/TaskTypes.spec.js +59 -0
- package/test/model/UpdateAttribute.spec.js +59 -0
- package/test/model/UpdateAttributeEnumeration.spec.js +59 -0
- package/test/model/UpdateBatchContacts.spec.js +53 -0
- package/test/model/UpdateBatchContactsContacts.spec.js +107 -0
- package/test/model/UpdateBatchContactsModel.spec.js +59 -0
- package/test/model/UpdateCampaignStatus.spec.js +53 -0
- package/test/model/UpdateChild.spec.js +77 -0
- package/test/model/UpdateChildAccountStatus.spec.js +71 -0
- package/test/model/UpdateChildDomain.spec.js +53 -0
- package/test/model/UpdateContact.spec.js +89 -0
- package/test/model/UpdateCouponCollection.spec.js +53 -0
- package/test/model/UpdateEmailCampaign.spec.js +233 -0
- package/test/model/UpdateEmailCampaignRecipients.spec.js +65 -0
- package/test/model/UpdateEmailCampaignSender.spec.js +65 -0
- package/test/model/UpdateExternalFeed.spec.js +101 -0
- package/test/model/UpdateList.spec.js +59 -0
- package/test/model/UpdateSender.spec.js +65 -0
- package/test/model/UpdateSmsCampaign.spec.js +95 -0
- package/test/model/UpdateSmtpTemplate.spec.js +107 -0
- package/test/model/UpdateSmtpTemplateSender.spec.js +65 -0
- package/test/model/UpdateWebhook.spec.js +71 -0
- package/test/model/UpdateWhatsAppCampaign.spec.js +71 -0
- package/test/model/UploadImageModel.spec.js +53 -0
- package/test/model/UploadImageToGallery.spec.js +59 -0
- package/test/model/VariablesItems.spec.js +65 -0
- package/test/model/WhatsappCampStats.spec.js +77 -0
- package/test/model/WhatsappCampTemplate.spec.js +113 -0
|
@@ -0,0 +1,1318 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Brevo API
|
|
3
|
+
* 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/brevo **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 |
|
|
4
|
+
*
|
|
5
|
+
* OpenAPI spec version: 3.0.0
|
|
6
|
+
* Contact: contact@brevo.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by the swagger code generator program.
|
|
9
|
+
* https://github.com/swagger-api/swagger-codegen.git
|
|
10
|
+
*
|
|
11
|
+
* Swagger Codegen version: 2.4.32
|
|
12
|
+
*
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*
|
|
15
|
+
*/
|
|
16
|
+
|
|
17
|
+
(function(root, factory) {
|
|
18
|
+
if (typeof define === 'function' && define.amd) {
|
|
19
|
+
// AMD. Register as an anonymous module.
|
|
20
|
+
define(['ApiClient', 'model/BlockDomain', 'model/CreateModel', 'model/CreateSmtpEmail', 'model/CreateSmtpTemplate', 'model/DeleteHardbounces', 'model/ErrorModel', 'model/GetAggregatedReport', 'model/GetBlockedDomains', 'model/GetEmailEventReport', 'model/GetReports', 'model/GetScheduledEmailByBatchId', 'model/GetScheduledEmailByMessageId', 'model/GetSmtpTemplateOverview', 'model/GetSmtpTemplates', 'model/GetTransacBlockedContacts', 'model/GetTransacEmailContent', 'model/GetTransacEmailsList', 'model/PostSendFailed', 'model/ScheduleSmtpEmail', 'model/SendSmtpEmail', 'model/SendTestEmail', 'model/UpdateSmtpTemplate'], factory);
|
|
21
|
+
} else if (typeof module === 'object' && module.exports) {
|
|
22
|
+
// CommonJS-like environments that support module.exports, like Node.
|
|
23
|
+
module.exports = factory(require('../ApiClient'), require('../model/BlockDomain'), require('../model/CreateModel'), require('../model/CreateSmtpEmail'), require('../model/CreateSmtpTemplate'), require('../model/DeleteHardbounces'), require('../model/ErrorModel'), require('../model/GetAggregatedReport'), require('../model/GetBlockedDomains'), require('../model/GetEmailEventReport'), require('../model/GetReports'), require('../model/GetScheduledEmailByBatchId'), require('../model/GetScheduledEmailByMessageId'), require('../model/GetSmtpTemplateOverview'), require('../model/GetSmtpTemplates'), require('../model/GetTransacBlockedContacts'), require('../model/GetTransacEmailContent'), require('../model/GetTransacEmailsList'), require('../model/PostSendFailed'), require('../model/ScheduleSmtpEmail'), require('../model/SendSmtpEmail'), require('../model/SendTestEmail'), require('../model/UpdateSmtpTemplate'));
|
|
24
|
+
} else {
|
|
25
|
+
// Browser globals (root is window)
|
|
26
|
+
if (!root.Brevo) {
|
|
27
|
+
root.Brevo = {};
|
|
28
|
+
}
|
|
29
|
+
root.Brevo.TransactionalEmailsApi = factory(root.Brevo.ApiClient, root.Brevo.BlockDomain, root.Brevo.CreateModel, root.Brevo.CreateSmtpEmail, root.Brevo.CreateSmtpTemplate, root.Brevo.DeleteHardbounces, root.Brevo.ErrorModel, root.Brevo.GetAggregatedReport, root.Brevo.GetBlockedDomains, root.Brevo.GetEmailEventReport, root.Brevo.GetReports, root.Brevo.GetScheduledEmailByBatchId, root.Brevo.GetScheduledEmailByMessageId, root.Brevo.GetSmtpTemplateOverview, root.Brevo.GetSmtpTemplates, root.Brevo.GetTransacBlockedContacts, root.Brevo.GetTransacEmailContent, root.Brevo.GetTransacEmailsList, root.Brevo.PostSendFailed, root.Brevo.ScheduleSmtpEmail, root.Brevo.SendSmtpEmail, root.Brevo.SendTestEmail, root.Brevo.UpdateSmtpTemplate);
|
|
30
|
+
}
|
|
31
|
+
}(this, function(ApiClient, BlockDomain, CreateModel, CreateSmtpEmail, CreateSmtpTemplate, DeleteHardbounces, ErrorModel, GetAggregatedReport, GetBlockedDomains, GetEmailEventReport, GetReports, GetScheduledEmailByBatchId, GetScheduledEmailByMessageId, GetSmtpTemplateOverview, GetSmtpTemplates, GetTransacBlockedContacts, GetTransacEmailContent, GetTransacEmailsList, PostSendFailed, ScheduleSmtpEmail, SendSmtpEmail, SendTestEmail, UpdateSmtpTemplate) {
|
|
32
|
+
'use strict';
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* TransactionalEmails service.
|
|
36
|
+
* @module api/TransactionalEmailsApi
|
|
37
|
+
* @version 1.0.0
|
|
38
|
+
*/
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* Constructs a new TransactionalEmailsApi.
|
|
42
|
+
* @alias module:api/TransactionalEmailsApi
|
|
43
|
+
* @class
|
|
44
|
+
* @param {module:ApiClient} [apiClient] Optional API client implementation to use,
|
|
45
|
+
* default to {@link module:ApiClient#instance} if unspecified.
|
|
46
|
+
*/
|
|
47
|
+
var exports = function(apiClient) {
|
|
48
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
/**
|
|
53
|
+
* Add a new domain to the list of blocked domains
|
|
54
|
+
* Blocks a new domain in order to avoid messages being sent to the same
|
|
55
|
+
* @param {module:model/BlockDomain} blockDomain
|
|
56
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
57
|
+
*/
|
|
58
|
+
this.blockNewDomainWithHttpInfo = function(blockDomain) {
|
|
59
|
+
var postBody = blockDomain;
|
|
60
|
+
|
|
61
|
+
// verify the required parameter 'blockDomain' is set
|
|
62
|
+
if (blockDomain === undefined || blockDomain === null) {
|
|
63
|
+
throw new Error("Missing the required parameter 'blockDomain' when calling blockNewDomain");
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
var pathParams = {
|
|
68
|
+
};
|
|
69
|
+
var queryParams = {
|
|
70
|
+
};
|
|
71
|
+
var collectionQueryParams = {
|
|
72
|
+
};
|
|
73
|
+
var headerParams = {
|
|
74
|
+
};
|
|
75
|
+
var formParams = {
|
|
76
|
+
};
|
|
77
|
+
|
|
78
|
+
var authNames = ['api-key', 'partner-key'];
|
|
79
|
+
var contentTypes = ['application/json'];
|
|
80
|
+
var accepts = ['application/json'];
|
|
81
|
+
var returnType = null;
|
|
82
|
+
|
|
83
|
+
return this.apiClient.callApi(
|
|
84
|
+
'/smtp/blockedDomains', 'POST',
|
|
85
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
86
|
+
authNames, contentTypes, accepts, returnType
|
|
87
|
+
);
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
/**
|
|
91
|
+
* Add a new domain to the list of blocked domains
|
|
92
|
+
* Blocks a new domain in order to avoid messages being sent to the same
|
|
93
|
+
* @param {module:model/BlockDomain} blockDomain
|
|
94
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
95
|
+
*/
|
|
96
|
+
this.blockNewDomain = function(blockDomain) {
|
|
97
|
+
return this.blockNewDomainWithHttpInfo(blockDomain)
|
|
98
|
+
.then(function(response_and_data) {
|
|
99
|
+
return response_and_data.data;
|
|
100
|
+
});
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
/**
|
|
105
|
+
* Create an email template
|
|
106
|
+
* @param {module:model/CreateSmtpTemplate} smtpTemplate values to update in transactional email template
|
|
107
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateModel} and HTTP response
|
|
108
|
+
*/
|
|
109
|
+
this.createSmtpTemplateWithHttpInfo = function(smtpTemplate) {
|
|
110
|
+
var postBody = smtpTemplate;
|
|
111
|
+
|
|
112
|
+
// verify the required parameter 'smtpTemplate' is set
|
|
113
|
+
if (smtpTemplate === undefined || smtpTemplate === null) {
|
|
114
|
+
throw new Error("Missing the required parameter 'smtpTemplate' when calling createSmtpTemplate");
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
var pathParams = {
|
|
119
|
+
};
|
|
120
|
+
var queryParams = {
|
|
121
|
+
};
|
|
122
|
+
var collectionQueryParams = {
|
|
123
|
+
};
|
|
124
|
+
var headerParams = {
|
|
125
|
+
};
|
|
126
|
+
var formParams = {
|
|
127
|
+
};
|
|
128
|
+
|
|
129
|
+
var authNames = ['api-key', 'partner-key'];
|
|
130
|
+
var contentTypes = ['application/json'];
|
|
131
|
+
var accepts = ['application/json'];
|
|
132
|
+
var returnType = CreateModel;
|
|
133
|
+
|
|
134
|
+
return this.apiClient.callApi(
|
|
135
|
+
'/smtp/templates', 'POST',
|
|
136
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
137
|
+
authNames, contentTypes, accepts, returnType
|
|
138
|
+
);
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
/**
|
|
142
|
+
* Create an email template
|
|
143
|
+
* @param {module:model/CreateSmtpTemplate} smtpTemplate values to update in transactional email template
|
|
144
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateModel}
|
|
145
|
+
*/
|
|
146
|
+
this.createSmtpTemplate = function(smtpTemplate) {
|
|
147
|
+
return this.createSmtpTemplateWithHttpInfo(smtpTemplate)
|
|
148
|
+
.then(function(response_and_data) {
|
|
149
|
+
return response_and_data.data;
|
|
150
|
+
});
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
/**
|
|
155
|
+
* Unblock an existing domain from the list of blocked domains
|
|
156
|
+
* Unblocks an existing domain from the list of blocked domains
|
|
157
|
+
* @param {String} domain The name of the domain to be deleted
|
|
158
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
159
|
+
*/
|
|
160
|
+
this.deleteBlockedDomainWithHttpInfo = function(domain) {
|
|
161
|
+
var postBody = null;
|
|
162
|
+
|
|
163
|
+
// verify the required parameter 'domain' is set
|
|
164
|
+
if (domain === undefined || domain === null) {
|
|
165
|
+
throw new Error("Missing the required parameter 'domain' when calling deleteBlockedDomain");
|
|
166
|
+
}
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
var pathParams = {
|
|
170
|
+
'domain': domain
|
|
171
|
+
};
|
|
172
|
+
var queryParams = {
|
|
173
|
+
};
|
|
174
|
+
var collectionQueryParams = {
|
|
175
|
+
};
|
|
176
|
+
var headerParams = {
|
|
177
|
+
};
|
|
178
|
+
var formParams = {
|
|
179
|
+
};
|
|
180
|
+
|
|
181
|
+
var authNames = ['api-key', 'partner-key'];
|
|
182
|
+
var contentTypes = ['application/json'];
|
|
183
|
+
var accepts = ['application/json'];
|
|
184
|
+
var returnType = null;
|
|
185
|
+
|
|
186
|
+
return this.apiClient.callApi(
|
|
187
|
+
'/smtp/blockedDomains/{domain}', 'DELETE',
|
|
188
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
189
|
+
authNames, contentTypes, accepts, returnType
|
|
190
|
+
);
|
|
191
|
+
}
|
|
192
|
+
|
|
193
|
+
/**
|
|
194
|
+
* Unblock an existing domain from the list of blocked domains
|
|
195
|
+
* Unblocks an existing domain from the list of blocked domains
|
|
196
|
+
* @param {String} domain The name of the domain to be deleted
|
|
197
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
198
|
+
*/
|
|
199
|
+
this.deleteBlockedDomain = function(domain) {
|
|
200
|
+
return this.deleteBlockedDomainWithHttpInfo(domain)
|
|
201
|
+
.then(function(response_and_data) {
|
|
202
|
+
return response_and_data.data;
|
|
203
|
+
});
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
/**
|
|
208
|
+
* Delete hardbounces
|
|
209
|
+
* Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures)
|
|
210
|
+
* @param {Object} opts Optional parameters
|
|
211
|
+
* @param {module:model/DeleteHardbounces} opts.deleteHardbounces values to delete hardbounces
|
|
212
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
213
|
+
*/
|
|
214
|
+
this.deleteHardbouncesWithHttpInfo = function(opts) {
|
|
215
|
+
opts = opts || {};
|
|
216
|
+
var postBody = opts['deleteHardbounces'];
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
var pathParams = {
|
|
220
|
+
};
|
|
221
|
+
var queryParams = {
|
|
222
|
+
};
|
|
223
|
+
var collectionQueryParams = {
|
|
224
|
+
};
|
|
225
|
+
var headerParams = {
|
|
226
|
+
};
|
|
227
|
+
var formParams = {
|
|
228
|
+
};
|
|
229
|
+
|
|
230
|
+
var authNames = ['api-key', 'partner-key'];
|
|
231
|
+
var contentTypes = ['application/json'];
|
|
232
|
+
var accepts = ['application/json'];
|
|
233
|
+
var returnType = null;
|
|
234
|
+
|
|
235
|
+
return this.apiClient.callApi(
|
|
236
|
+
'/smtp/deleteHardbounces', 'POST',
|
|
237
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
238
|
+
authNames, contentTypes, accepts, returnType
|
|
239
|
+
);
|
|
240
|
+
}
|
|
241
|
+
|
|
242
|
+
/**
|
|
243
|
+
* Delete hardbounces
|
|
244
|
+
* Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures)
|
|
245
|
+
* @param {Object} opts Optional parameters
|
|
246
|
+
* @param {module:model/DeleteHardbounces} opts.deleteHardbounces values to delete hardbounces
|
|
247
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
248
|
+
*/
|
|
249
|
+
this.deleteHardbounces = function(opts) {
|
|
250
|
+
return this.deleteHardbouncesWithHttpInfo(opts)
|
|
251
|
+
.then(function(response_and_data) {
|
|
252
|
+
return response_and_data.data;
|
|
253
|
+
});
|
|
254
|
+
}
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
/**
|
|
258
|
+
* Delete scheduled emails by batchId or messageId
|
|
259
|
+
* Delete scheduled batch of emails by batchId or single scheduled email by messageId
|
|
260
|
+
* @param {String} identifier The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email.
|
|
261
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
262
|
+
*/
|
|
263
|
+
this.deleteScheduledEmailByIdWithHttpInfo = function(identifier) {
|
|
264
|
+
var postBody = null;
|
|
265
|
+
|
|
266
|
+
// verify the required parameter 'identifier' is set
|
|
267
|
+
if (identifier === undefined || identifier === null) {
|
|
268
|
+
throw new Error("Missing the required parameter 'identifier' when calling deleteScheduledEmailById");
|
|
269
|
+
}
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
var pathParams = {
|
|
273
|
+
'identifier': identifier
|
|
274
|
+
};
|
|
275
|
+
var queryParams = {
|
|
276
|
+
};
|
|
277
|
+
var collectionQueryParams = {
|
|
278
|
+
};
|
|
279
|
+
var headerParams = {
|
|
280
|
+
};
|
|
281
|
+
var formParams = {
|
|
282
|
+
};
|
|
283
|
+
|
|
284
|
+
var authNames = ['api-key', 'partner-key'];
|
|
285
|
+
var contentTypes = ['application/json'];
|
|
286
|
+
var accepts = ['application/json'];
|
|
287
|
+
var returnType = null;
|
|
288
|
+
|
|
289
|
+
return this.apiClient.callApi(
|
|
290
|
+
'/smtp/email/{identifier}', 'DELETE',
|
|
291
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
292
|
+
authNames, contentTypes, accepts, returnType
|
|
293
|
+
);
|
|
294
|
+
}
|
|
295
|
+
|
|
296
|
+
/**
|
|
297
|
+
* Delete scheduled emails by batchId or messageId
|
|
298
|
+
* Delete scheduled batch of emails by batchId or single scheduled email by messageId
|
|
299
|
+
* @param {String} identifier The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email.
|
|
300
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
301
|
+
*/
|
|
302
|
+
this.deleteScheduledEmailById = function(identifier) {
|
|
303
|
+
return this.deleteScheduledEmailByIdWithHttpInfo(identifier)
|
|
304
|
+
.then(function(response_and_data) {
|
|
305
|
+
return response_and_data.data;
|
|
306
|
+
});
|
|
307
|
+
}
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
/**
|
|
311
|
+
* Delete an inactive email template
|
|
312
|
+
* @param {Number} templateId id of the template
|
|
313
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
314
|
+
*/
|
|
315
|
+
this.deleteSmtpTemplateWithHttpInfo = function(templateId) {
|
|
316
|
+
var postBody = null;
|
|
317
|
+
|
|
318
|
+
// verify the required parameter 'templateId' is set
|
|
319
|
+
if (templateId === undefined || templateId === null) {
|
|
320
|
+
throw new Error("Missing the required parameter 'templateId' when calling deleteSmtpTemplate");
|
|
321
|
+
}
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
var pathParams = {
|
|
325
|
+
'templateId': templateId
|
|
326
|
+
};
|
|
327
|
+
var queryParams = {
|
|
328
|
+
};
|
|
329
|
+
var collectionQueryParams = {
|
|
330
|
+
};
|
|
331
|
+
var headerParams = {
|
|
332
|
+
};
|
|
333
|
+
var formParams = {
|
|
334
|
+
};
|
|
335
|
+
|
|
336
|
+
var authNames = ['api-key', 'partner-key'];
|
|
337
|
+
var contentTypes = ['application/json'];
|
|
338
|
+
var accepts = ['application/json'];
|
|
339
|
+
var returnType = null;
|
|
340
|
+
|
|
341
|
+
return this.apiClient.callApi(
|
|
342
|
+
'/smtp/templates/{templateId}', 'DELETE',
|
|
343
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
344
|
+
authNames, contentTypes, accepts, returnType
|
|
345
|
+
);
|
|
346
|
+
}
|
|
347
|
+
|
|
348
|
+
/**
|
|
349
|
+
* Delete an inactive email template
|
|
350
|
+
* @param {Number} templateId id of the template
|
|
351
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
352
|
+
*/
|
|
353
|
+
this.deleteSmtpTemplate = function(templateId) {
|
|
354
|
+
return this.deleteSmtpTemplateWithHttpInfo(templateId)
|
|
355
|
+
.then(function(response_and_data) {
|
|
356
|
+
return response_and_data.data;
|
|
357
|
+
});
|
|
358
|
+
}
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
/**
|
|
362
|
+
* Get your transactional email activity aggregated over a period of time
|
|
363
|
+
* This endpoint will show the aggregated stats for past 90 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days
|
|
364
|
+
* @param {Object} opts Optional parameters
|
|
365
|
+
* @param {String} opts.startDate Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
|
366
|
+
* @param {String} opts.endDate Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
|
367
|
+
* @param {Number} opts.days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
|
368
|
+
* @param {String} opts.tag Tag of the emails
|
|
369
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetAggregatedReport} and HTTP response
|
|
370
|
+
*/
|
|
371
|
+
this.getAggregatedSmtpReportWithHttpInfo = function(opts) {
|
|
372
|
+
opts = opts || {};
|
|
373
|
+
var postBody = null;
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
var pathParams = {
|
|
377
|
+
};
|
|
378
|
+
var queryParams = {
|
|
379
|
+
'startDate': opts['startDate'],
|
|
380
|
+
'endDate': opts['endDate'],
|
|
381
|
+
'days': opts['days'],
|
|
382
|
+
'tag': opts['tag'],
|
|
383
|
+
};
|
|
384
|
+
var collectionQueryParams = {
|
|
385
|
+
};
|
|
386
|
+
var headerParams = {
|
|
387
|
+
};
|
|
388
|
+
var formParams = {
|
|
389
|
+
};
|
|
390
|
+
|
|
391
|
+
var authNames = ['api-key', 'partner-key'];
|
|
392
|
+
var contentTypes = ['application/json'];
|
|
393
|
+
var accepts = ['application/json'];
|
|
394
|
+
var returnType = GetAggregatedReport;
|
|
395
|
+
|
|
396
|
+
return this.apiClient.callApi(
|
|
397
|
+
'/smtp/statistics/aggregatedReport', 'GET',
|
|
398
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
399
|
+
authNames, contentTypes, accepts, returnType
|
|
400
|
+
);
|
|
401
|
+
}
|
|
402
|
+
|
|
403
|
+
/**
|
|
404
|
+
* Get your transactional email activity aggregated over a period of time
|
|
405
|
+
* This endpoint will show the aggregated stats for past 90 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days
|
|
406
|
+
* @param {Object} opts Optional parameters
|
|
407
|
+
* @param {String} opts.startDate Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
|
408
|
+
* @param {String} opts.endDate Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
|
409
|
+
* @param {Number} opts.days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
|
410
|
+
* @param {String} opts.tag Tag of the emails
|
|
411
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetAggregatedReport}
|
|
412
|
+
*/
|
|
413
|
+
this.getAggregatedSmtpReport = function(opts) {
|
|
414
|
+
return this.getAggregatedSmtpReportWithHttpInfo(opts)
|
|
415
|
+
.then(function(response_and_data) {
|
|
416
|
+
return response_and_data.data;
|
|
417
|
+
});
|
|
418
|
+
}
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
/**
|
|
422
|
+
* Get the list of blocked domains
|
|
423
|
+
* Get the list of blocked domains
|
|
424
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetBlockedDomains} and HTTP response
|
|
425
|
+
*/
|
|
426
|
+
this.getBlockedDomainsWithHttpInfo = function() {
|
|
427
|
+
var postBody = null;
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
var pathParams = {
|
|
431
|
+
};
|
|
432
|
+
var queryParams = {
|
|
433
|
+
};
|
|
434
|
+
var collectionQueryParams = {
|
|
435
|
+
};
|
|
436
|
+
var headerParams = {
|
|
437
|
+
};
|
|
438
|
+
var formParams = {
|
|
439
|
+
};
|
|
440
|
+
|
|
441
|
+
var authNames = ['api-key', 'partner-key'];
|
|
442
|
+
var contentTypes = ['application/json'];
|
|
443
|
+
var accepts = ['application/json'];
|
|
444
|
+
var returnType = GetBlockedDomains;
|
|
445
|
+
|
|
446
|
+
return this.apiClient.callApi(
|
|
447
|
+
'/smtp/blockedDomains', 'GET',
|
|
448
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
449
|
+
authNames, contentTypes, accepts, returnType
|
|
450
|
+
);
|
|
451
|
+
}
|
|
452
|
+
|
|
453
|
+
/**
|
|
454
|
+
* Get the list of blocked domains
|
|
455
|
+
* Get the list of blocked domains
|
|
456
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetBlockedDomains}
|
|
457
|
+
*/
|
|
458
|
+
this.getBlockedDomains = function() {
|
|
459
|
+
return this.getBlockedDomainsWithHttpInfo()
|
|
460
|
+
.then(function(response_and_data) {
|
|
461
|
+
return response_and_data.data;
|
|
462
|
+
});
|
|
463
|
+
}
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
/**
|
|
467
|
+
* Get all your transactional email activity (unaggregated events)
|
|
468
|
+
* This endpoint will show the aggregated stats for past 30 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days
|
|
469
|
+
* @param {Object} opts Optional parameters
|
|
470
|
+
* @param {Number} opts.limit Number limitation for the result returned (default to 2500)
|
|
471
|
+
* @param {Number} opts.offset Beginning point in the list to retrieve from. (default to 0)
|
|
472
|
+
* @param {String} opts.startDate Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
|
473
|
+
* @param {String} opts.endDate Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
|
474
|
+
* @param {Number} opts.days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
|
475
|
+
* @param {String} opts.email Filter the report for a specific email addresses
|
|
476
|
+
* @param {module:model/String} opts.event Filter the report for a specific event type
|
|
477
|
+
* @param {String} opts.tags Filter the report for tags (serialized and urlencoded array)
|
|
478
|
+
* @param {String} opts.messageId Filter on a specific message id
|
|
479
|
+
* @param {Number} opts.templateId Filter on a specific template id
|
|
480
|
+
* @param {module:model/String} opts.sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
|
481
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetEmailEventReport} and HTTP response
|
|
482
|
+
*/
|
|
483
|
+
this.getEmailEventReportWithHttpInfo = function(opts) {
|
|
484
|
+
opts = opts || {};
|
|
485
|
+
var postBody = null;
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
var pathParams = {
|
|
489
|
+
};
|
|
490
|
+
var queryParams = {
|
|
491
|
+
'limit': opts['limit'],
|
|
492
|
+
'offset': opts['offset'],
|
|
493
|
+
'startDate': opts['startDate'],
|
|
494
|
+
'endDate': opts['endDate'],
|
|
495
|
+
'days': opts['days'],
|
|
496
|
+
'email': opts['email'],
|
|
497
|
+
'event': opts['event'],
|
|
498
|
+
'tags': opts['tags'],
|
|
499
|
+
'messageId': opts['messageId'],
|
|
500
|
+
'templateId': opts['templateId'],
|
|
501
|
+
'sort': opts['sort'],
|
|
502
|
+
};
|
|
503
|
+
var collectionQueryParams = {
|
|
504
|
+
};
|
|
505
|
+
var headerParams = {
|
|
506
|
+
};
|
|
507
|
+
var formParams = {
|
|
508
|
+
};
|
|
509
|
+
|
|
510
|
+
var authNames = ['api-key', 'partner-key'];
|
|
511
|
+
var contentTypes = ['application/json'];
|
|
512
|
+
var accepts = ['application/json'];
|
|
513
|
+
var returnType = GetEmailEventReport;
|
|
514
|
+
|
|
515
|
+
return this.apiClient.callApi(
|
|
516
|
+
'/smtp/statistics/events', 'GET',
|
|
517
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
518
|
+
authNames, contentTypes, accepts, returnType
|
|
519
|
+
);
|
|
520
|
+
}
|
|
521
|
+
|
|
522
|
+
/**
|
|
523
|
+
* Get all your transactional email activity (unaggregated events)
|
|
524
|
+
* This endpoint will show the aggregated stats for past 30 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days
|
|
525
|
+
* @param {Object} opts Optional parameters
|
|
526
|
+
* @param {Number} opts.limit Number limitation for the result returned (default to 2500)
|
|
527
|
+
* @param {Number} opts.offset Beginning point in the list to retrieve from. (default to 0)
|
|
528
|
+
* @param {String} opts.startDate Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
|
529
|
+
* @param {String} opts.endDate Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
|
530
|
+
* @param {Number} opts.days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
|
531
|
+
* @param {String} opts.email Filter the report for a specific email addresses
|
|
532
|
+
* @param {module:model/String} opts.event Filter the report for a specific event type
|
|
533
|
+
* @param {String} opts.tags Filter the report for tags (serialized and urlencoded array)
|
|
534
|
+
* @param {String} opts.messageId Filter on a specific message id
|
|
535
|
+
* @param {Number} opts.templateId Filter on a specific template id
|
|
536
|
+
* @param {module:model/String} opts.sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
|
537
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetEmailEventReport}
|
|
538
|
+
*/
|
|
539
|
+
this.getEmailEventReport = function(opts) {
|
|
540
|
+
return this.getEmailEventReportWithHttpInfo(opts)
|
|
541
|
+
.then(function(response_and_data) {
|
|
542
|
+
return response_and_data.data;
|
|
543
|
+
});
|
|
544
|
+
}
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
/**
|
|
548
|
+
* Fetch scheduled emails by batchId
|
|
549
|
+
* Fetch scheduled batch of emails by batchId (Can retrieve data upto 30 days old)
|
|
550
|
+
* @param {String} batchId The batchId of scheduled emails batch (Should be a valid UUIDv4)
|
|
551
|
+
* @param {Object} opts Optional parameters
|
|
552
|
+
* @param {Date} opts.startDate Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
|
|
553
|
+
* @param {Date} opts.endDate Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
|
|
554
|
+
* @param {module:model/String} opts.sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
|
555
|
+
* @param {module:model/String} opts.status Filter the records by `status` of the scheduled email batch or message.
|
|
556
|
+
* @param {Number} opts.limit Number of documents returned per page (default to 100)
|
|
557
|
+
* @param {Number} opts.offset Index of the first document on the page (default to 0)
|
|
558
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetScheduledEmailByBatchId} and HTTP response
|
|
559
|
+
*/
|
|
560
|
+
this.getScheduledEmailByBatchIdWithHttpInfo = function(batchId, opts) {
|
|
561
|
+
opts = opts || {};
|
|
562
|
+
var postBody = null;
|
|
563
|
+
|
|
564
|
+
// verify the required parameter 'batchId' is set
|
|
565
|
+
if (batchId === undefined || batchId === null) {
|
|
566
|
+
throw new Error("Missing the required parameter 'batchId' when calling getScheduledEmailByBatchId");
|
|
567
|
+
}
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
var pathParams = {
|
|
571
|
+
'batchId': batchId
|
|
572
|
+
};
|
|
573
|
+
var queryParams = {
|
|
574
|
+
'startDate': opts['startDate'],
|
|
575
|
+
'endDate': opts['endDate'],
|
|
576
|
+
'sort': opts['sort'],
|
|
577
|
+
'status': opts['status'],
|
|
578
|
+
'limit': opts['limit'],
|
|
579
|
+
'offset': opts['offset'],
|
|
580
|
+
};
|
|
581
|
+
var collectionQueryParams = {
|
|
582
|
+
};
|
|
583
|
+
var headerParams = {
|
|
584
|
+
};
|
|
585
|
+
var formParams = {
|
|
586
|
+
};
|
|
587
|
+
|
|
588
|
+
var authNames = ['api-key', 'partner-key'];
|
|
589
|
+
var contentTypes = ['application/json'];
|
|
590
|
+
var accepts = ['application/json'];
|
|
591
|
+
var returnType = GetScheduledEmailByBatchId;
|
|
592
|
+
|
|
593
|
+
return this.apiClient.callApi(
|
|
594
|
+
'/smtp/emailStatus/{batchId}', 'GET',
|
|
595
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
596
|
+
authNames, contentTypes, accepts, returnType
|
|
597
|
+
);
|
|
598
|
+
}
|
|
599
|
+
|
|
600
|
+
/**
|
|
601
|
+
* Fetch scheduled emails by batchId
|
|
602
|
+
* Fetch scheduled batch of emails by batchId (Can retrieve data upto 30 days old)
|
|
603
|
+
* @param {String} batchId The batchId of scheduled emails batch (Should be a valid UUIDv4)
|
|
604
|
+
* @param {Object} opts Optional parameters
|
|
605
|
+
* @param {Date} opts.startDate Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
|
|
606
|
+
* @param {Date} opts.endDate Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
|
|
607
|
+
* @param {module:model/String} opts.sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
|
608
|
+
* @param {module:model/String} opts.status Filter the records by `status` of the scheduled email batch or message.
|
|
609
|
+
* @param {Number} opts.limit Number of documents returned per page (default to 100)
|
|
610
|
+
* @param {Number} opts.offset Index of the first document on the page (default to 0)
|
|
611
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetScheduledEmailByBatchId}
|
|
612
|
+
*/
|
|
613
|
+
this.getScheduledEmailByBatchId = function(batchId, opts) {
|
|
614
|
+
return this.getScheduledEmailByBatchIdWithHttpInfo(batchId, opts)
|
|
615
|
+
.then(function(response_and_data) {
|
|
616
|
+
return response_and_data.data;
|
|
617
|
+
});
|
|
618
|
+
}
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
/**
|
|
622
|
+
* Fetch scheduled email by messageId
|
|
623
|
+
* Fetch scheduled email by messageId (Can retrieve data upto 30 days old)
|
|
624
|
+
* @param {String} messageId The messageId of scheduled email
|
|
625
|
+
* @param {Object} opts Optional parameters
|
|
626
|
+
* @param {Date} opts.startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
|
|
627
|
+
* @param {Date} opts.endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
|
|
628
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetScheduledEmailByMessageId} and HTTP response
|
|
629
|
+
*/
|
|
630
|
+
this.getScheduledEmailByMessageIdWithHttpInfo = function(messageId, opts) {
|
|
631
|
+
opts = opts || {};
|
|
632
|
+
var postBody = null;
|
|
633
|
+
|
|
634
|
+
// verify the required parameter 'messageId' is set
|
|
635
|
+
if (messageId === undefined || messageId === null) {
|
|
636
|
+
throw new Error("Missing the required parameter 'messageId' when calling getScheduledEmailByMessageId");
|
|
637
|
+
}
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
var pathParams = {
|
|
641
|
+
'messageId': messageId
|
|
642
|
+
};
|
|
643
|
+
var queryParams = {
|
|
644
|
+
'startDate': opts['startDate'],
|
|
645
|
+
'endDate': opts['endDate'],
|
|
646
|
+
};
|
|
647
|
+
var collectionQueryParams = {
|
|
648
|
+
};
|
|
649
|
+
var headerParams = {
|
|
650
|
+
};
|
|
651
|
+
var formParams = {
|
|
652
|
+
};
|
|
653
|
+
|
|
654
|
+
var authNames = ['api-key', 'partner-key'];
|
|
655
|
+
var contentTypes = ['application/json'];
|
|
656
|
+
var accepts = ['application/json'];
|
|
657
|
+
var returnType = GetScheduledEmailByMessageId;
|
|
658
|
+
|
|
659
|
+
return this.apiClient.callApi(
|
|
660
|
+
'/smtp/emailStatus/{messageId}', 'GET',
|
|
661
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
662
|
+
authNames, contentTypes, accepts, returnType
|
|
663
|
+
);
|
|
664
|
+
}
|
|
665
|
+
|
|
666
|
+
/**
|
|
667
|
+
* Fetch scheduled email by messageId
|
|
668
|
+
* Fetch scheduled email by messageId (Can retrieve data upto 30 days old)
|
|
669
|
+
* @param {String} messageId The messageId of scheduled email
|
|
670
|
+
* @param {Object} opts Optional parameters
|
|
671
|
+
* @param {Date} opts.startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
|
|
672
|
+
* @param {Date} opts.endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
|
|
673
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetScheduledEmailByMessageId}
|
|
674
|
+
*/
|
|
675
|
+
this.getScheduledEmailByMessageId = function(messageId, opts) {
|
|
676
|
+
return this.getScheduledEmailByMessageIdWithHttpInfo(messageId, opts)
|
|
677
|
+
.then(function(response_and_data) {
|
|
678
|
+
return response_and_data.data;
|
|
679
|
+
});
|
|
680
|
+
}
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
/**
|
|
684
|
+
* Get your transactional email activity aggregated per day
|
|
685
|
+
* @param {Object} opts Optional parameters
|
|
686
|
+
* @param {Number} opts.limit Number of documents returned per page (default to 10)
|
|
687
|
+
* @param {Number} opts.offset Index of the first document on the page (default to 0)
|
|
688
|
+
* @param {String} opts.startDate Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
|
|
689
|
+
* @param {String} opts.endDate Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
|
|
690
|
+
* @param {Number} opts.days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
|
691
|
+
* @param {String} opts.tag Tag of the emails
|
|
692
|
+
* @param {module:model/String} opts.sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
|
693
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetReports} and HTTP response
|
|
694
|
+
*/
|
|
695
|
+
this.getSmtpReportWithHttpInfo = function(opts) {
|
|
696
|
+
opts = opts || {};
|
|
697
|
+
var postBody = null;
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
var pathParams = {
|
|
701
|
+
};
|
|
702
|
+
var queryParams = {
|
|
703
|
+
'limit': opts['limit'],
|
|
704
|
+
'offset': opts['offset'],
|
|
705
|
+
'startDate': opts['startDate'],
|
|
706
|
+
'endDate': opts['endDate'],
|
|
707
|
+
'days': opts['days'],
|
|
708
|
+
'tag': opts['tag'],
|
|
709
|
+
'sort': opts['sort'],
|
|
710
|
+
};
|
|
711
|
+
var collectionQueryParams = {
|
|
712
|
+
};
|
|
713
|
+
var headerParams = {
|
|
714
|
+
};
|
|
715
|
+
var formParams = {
|
|
716
|
+
};
|
|
717
|
+
|
|
718
|
+
var authNames = ['api-key', 'partner-key'];
|
|
719
|
+
var contentTypes = ['application/json'];
|
|
720
|
+
var accepts = ['application/json'];
|
|
721
|
+
var returnType = GetReports;
|
|
722
|
+
|
|
723
|
+
return this.apiClient.callApi(
|
|
724
|
+
'/smtp/statistics/reports', 'GET',
|
|
725
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
726
|
+
authNames, contentTypes, accepts, returnType
|
|
727
|
+
);
|
|
728
|
+
}
|
|
729
|
+
|
|
730
|
+
/**
|
|
731
|
+
* Get your transactional email activity aggregated per day
|
|
732
|
+
* @param {Object} opts Optional parameters
|
|
733
|
+
* @param {Number} opts.limit Number of documents returned per page (default to 10)
|
|
734
|
+
* @param {Number} opts.offset Index of the first document on the page (default to 0)
|
|
735
|
+
* @param {String} opts.startDate Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
|
|
736
|
+
* @param {String} opts.endDate Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
|
|
737
|
+
* @param {Number} opts.days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
|
738
|
+
* @param {String} opts.tag Tag of the emails
|
|
739
|
+
* @param {module:model/String} opts.sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
|
740
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetReports}
|
|
741
|
+
*/
|
|
742
|
+
this.getSmtpReport = function(opts) {
|
|
743
|
+
return this.getSmtpReportWithHttpInfo(opts)
|
|
744
|
+
.then(function(response_and_data) {
|
|
745
|
+
return response_and_data.data;
|
|
746
|
+
});
|
|
747
|
+
}
|
|
748
|
+
|
|
749
|
+
|
|
750
|
+
/**
|
|
751
|
+
* Returns the template information
|
|
752
|
+
* @param {Number} templateId id of the template
|
|
753
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetSmtpTemplateOverview} and HTTP response
|
|
754
|
+
*/
|
|
755
|
+
this.getSmtpTemplateWithHttpInfo = function(templateId) {
|
|
756
|
+
var postBody = null;
|
|
757
|
+
|
|
758
|
+
// verify the required parameter 'templateId' is set
|
|
759
|
+
if (templateId === undefined || templateId === null) {
|
|
760
|
+
throw new Error("Missing the required parameter 'templateId' when calling getSmtpTemplate");
|
|
761
|
+
}
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
var pathParams = {
|
|
765
|
+
'templateId': templateId
|
|
766
|
+
};
|
|
767
|
+
var queryParams = {
|
|
768
|
+
};
|
|
769
|
+
var collectionQueryParams = {
|
|
770
|
+
};
|
|
771
|
+
var headerParams = {
|
|
772
|
+
};
|
|
773
|
+
var formParams = {
|
|
774
|
+
};
|
|
775
|
+
|
|
776
|
+
var authNames = ['api-key', 'partner-key'];
|
|
777
|
+
var contentTypes = ['application/json'];
|
|
778
|
+
var accepts = ['application/json'];
|
|
779
|
+
var returnType = GetSmtpTemplateOverview;
|
|
780
|
+
|
|
781
|
+
return this.apiClient.callApi(
|
|
782
|
+
'/smtp/templates/{templateId}', 'GET',
|
|
783
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
784
|
+
authNames, contentTypes, accepts, returnType
|
|
785
|
+
);
|
|
786
|
+
}
|
|
787
|
+
|
|
788
|
+
/**
|
|
789
|
+
* Returns the template information
|
|
790
|
+
* @param {Number} templateId id of the template
|
|
791
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetSmtpTemplateOverview}
|
|
792
|
+
*/
|
|
793
|
+
this.getSmtpTemplate = function(templateId) {
|
|
794
|
+
return this.getSmtpTemplateWithHttpInfo(templateId)
|
|
795
|
+
.then(function(response_and_data) {
|
|
796
|
+
return response_and_data.data;
|
|
797
|
+
});
|
|
798
|
+
}
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
/**
|
|
802
|
+
* Get the list of email templates
|
|
803
|
+
* @param {Object} opts Optional parameters
|
|
804
|
+
* @param {Boolean} opts.templateStatus Filter on the status of the template. Active = true, inactive = false
|
|
805
|
+
* @param {Number} opts.limit Number of documents returned per page (default to 50)
|
|
806
|
+
* @param {Number} opts.offset Index of the first document in the page (default to 0)
|
|
807
|
+
* @param {module:model/String} opts.sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
|
808
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetSmtpTemplates} and HTTP response
|
|
809
|
+
*/
|
|
810
|
+
this.getSmtpTemplatesWithHttpInfo = function(opts) {
|
|
811
|
+
opts = opts || {};
|
|
812
|
+
var postBody = null;
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
var pathParams = {
|
|
816
|
+
};
|
|
817
|
+
var queryParams = {
|
|
818
|
+
'templateStatus': opts['templateStatus'],
|
|
819
|
+
'limit': opts['limit'],
|
|
820
|
+
'offset': opts['offset'],
|
|
821
|
+
'sort': opts['sort'],
|
|
822
|
+
};
|
|
823
|
+
var collectionQueryParams = {
|
|
824
|
+
};
|
|
825
|
+
var headerParams = {
|
|
826
|
+
};
|
|
827
|
+
var formParams = {
|
|
828
|
+
};
|
|
829
|
+
|
|
830
|
+
var authNames = ['api-key', 'partner-key'];
|
|
831
|
+
var contentTypes = ['application/json'];
|
|
832
|
+
var accepts = ['application/json'];
|
|
833
|
+
var returnType = GetSmtpTemplates;
|
|
834
|
+
|
|
835
|
+
return this.apiClient.callApi(
|
|
836
|
+
'/smtp/templates', 'GET',
|
|
837
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
838
|
+
authNames, contentTypes, accepts, returnType
|
|
839
|
+
);
|
|
840
|
+
}
|
|
841
|
+
|
|
842
|
+
/**
|
|
843
|
+
* Get the list of email templates
|
|
844
|
+
* @param {Object} opts Optional parameters
|
|
845
|
+
* @param {Boolean} opts.templateStatus Filter on the status of the template. Active = true, inactive = false
|
|
846
|
+
* @param {Number} opts.limit Number of documents returned per page (default to 50)
|
|
847
|
+
* @param {Number} opts.offset Index of the first document in the page (default to 0)
|
|
848
|
+
* @param {module:model/String} opts.sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
|
849
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetSmtpTemplates}
|
|
850
|
+
*/
|
|
851
|
+
this.getSmtpTemplates = function(opts) {
|
|
852
|
+
return this.getSmtpTemplatesWithHttpInfo(opts)
|
|
853
|
+
.then(function(response_and_data) {
|
|
854
|
+
return response_and_data.data;
|
|
855
|
+
});
|
|
856
|
+
}
|
|
857
|
+
|
|
858
|
+
|
|
859
|
+
/**
|
|
860
|
+
* Get the list of blocked or unsubscribed transactional contacts
|
|
861
|
+
* @param {Object} opts Optional parameters
|
|
862
|
+
* @param {String} opts.startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts
|
|
863
|
+
* @param {String} opts.endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts
|
|
864
|
+
* @param {Number} opts.limit Number of documents returned per page (default to 50)
|
|
865
|
+
* @param {Number} opts.offset Index of the first document on the page (default to 0)
|
|
866
|
+
* @param {Array.<String>} opts.senders Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
|
|
867
|
+
* @param {module:model/String} opts.sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
|
868
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetTransacBlockedContacts} and HTTP response
|
|
869
|
+
*/
|
|
870
|
+
this.getTransacBlockedContactsWithHttpInfo = function(opts) {
|
|
871
|
+
opts = opts || {};
|
|
872
|
+
var postBody = null;
|
|
873
|
+
|
|
874
|
+
|
|
875
|
+
var pathParams = {
|
|
876
|
+
};
|
|
877
|
+
var queryParams = {
|
|
878
|
+
'startDate': opts['startDate'],
|
|
879
|
+
'endDate': opts['endDate'],
|
|
880
|
+
'limit': opts['limit'],
|
|
881
|
+
'offset': opts['offset'],
|
|
882
|
+
'sort': opts['sort'],
|
|
883
|
+
};
|
|
884
|
+
var collectionQueryParams = {
|
|
885
|
+
'senders': {
|
|
886
|
+
value: opts['senders'],
|
|
887
|
+
collectionFormat: 'csv'
|
|
888
|
+
},
|
|
889
|
+
};
|
|
890
|
+
var headerParams = {
|
|
891
|
+
};
|
|
892
|
+
var formParams = {
|
|
893
|
+
};
|
|
894
|
+
|
|
895
|
+
var authNames = ['api-key', 'partner-key'];
|
|
896
|
+
var contentTypes = ['application/json'];
|
|
897
|
+
var accepts = ['application/json'];
|
|
898
|
+
var returnType = GetTransacBlockedContacts;
|
|
899
|
+
|
|
900
|
+
return this.apiClient.callApi(
|
|
901
|
+
'/smtp/blockedContacts', 'GET',
|
|
902
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
903
|
+
authNames, contentTypes, accepts, returnType
|
|
904
|
+
);
|
|
905
|
+
}
|
|
906
|
+
|
|
907
|
+
/**
|
|
908
|
+
* Get the list of blocked or unsubscribed transactional contacts
|
|
909
|
+
* @param {Object} opts Optional parameters
|
|
910
|
+
* @param {String} opts.startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts
|
|
911
|
+
* @param {String} opts.endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts
|
|
912
|
+
* @param {Number} opts.limit Number of documents returned per page (default to 50)
|
|
913
|
+
* @param {Number} opts.offset Index of the first document on the page (default to 0)
|
|
914
|
+
* @param {Array.<String>} opts.senders Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
|
|
915
|
+
* @param {module:model/String} opts.sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
|
916
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetTransacBlockedContacts}
|
|
917
|
+
*/
|
|
918
|
+
this.getTransacBlockedContacts = function(opts) {
|
|
919
|
+
return this.getTransacBlockedContactsWithHttpInfo(opts)
|
|
920
|
+
.then(function(response_and_data) {
|
|
921
|
+
return response_and_data.data;
|
|
922
|
+
});
|
|
923
|
+
}
|
|
924
|
+
|
|
925
|
+
|
|
926
|
+
/**
|
|
927
|
+
* Get the personalized content of a sent transactional email
|
|
928
|
+
* @param {String} uuid Unique id of the transactional email that has been sent to a particular contact
|
|
929
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetTransacEmailContent} and HTTP response
|
|
930
|
+
*/
|
|
931
|
+
this.getTransacEmailContentWithHttpInfo = function(uuid) {
|
|
932
|
+
var postBody = null;
|
|
933
|
+
|
|
934
|
+
// verify the required parameter 'uuid' is set
|
|
935
|
+
if (uuid === undefined || uuid === null) {
|
|
936
|
+
throw new Error("Missing the required parameter 'uuid' when calling getTransacEmailContent");
|
|
937
|
+
}
|
|
938
|
+
|
|
939
|
+
|
|
940
|
+
var pathParams = {
|
|
941
|
+
'uuid': uuid
|
|
942
|
+
};
|
|
943
|
+
var queryParams = {
|
|
944
|
+
};
|
|
945
|
+
var collectionQueryParams = {
|
|
946
|
+
};
|
|
947
|
+
var headerParams = {
|
|
948
|
+
};
|
|
949
|
+
var formParams = {
|
|
950
|
+
};
|
|
951
|
+
|
|
952
|
+
var authNames = ['api-key', 'partner-key'];
|
|
953
|
+
var contentTypes = ['application/json'];
|
|
954
|
+
var accepts = ['application/json'];
|
|
955
|
+
var returnType = GetTransacEmailContent;
|
|
956
|
+
|
|
957
|
+
return this.apiClient.callApi(
|
|
958
|
+
'/smtp/emails/{uuid}', 'GET',
|
|
959
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
960
|
+
authNames, contentTypes, accepts, returnType
|
|
961
|
+
);
|
|
962
|
+
}
|
|
963
|
+
|
|
964
|
+
/**
|
|
965
|
+
* Get the personalized content of a sent transactional email
|
|
966
|
+
* @param {String} uuid Unique id of the transactional email that has been sent to a particular contact
|
|
967
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetTransacEmailContent}
|
|
968
|
+
*/
|
|
969
|
+
this.getTransacEmailContent = function(uuid) {
|
|
970
|
+
return this.getTransacEmailContentWithHttpInfo(uuid)
|
|
971
|
+
.then(function(response_and_data) {
|
|
972
|
+
return response_and_data.data;
|
|
973
|
+
});
|
|
974
|
+
}
|
|
975
|
+
|
|
976
|
+
|
|
977
|
+
/**
|
|
978
|
+
* Get the list of transactional emails on the basis of allowed filters
|
|
979
|
+
* This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters.
|
|
980
|
+
* @param {Object} opts Optional parameters
|
|
981
|
+
* @param {String} opts.email Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
|
|
982
|
+
* @param {Number} opts.templateId Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
|
|
983
|
+
* @param {String} opts.messageId Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
|
|
984
|
+
* @param {String} opts.startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
|
|
985
|
+
* @param {String} opts.endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
|
|
986
|
+
* @param {module:model/String} opts.sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
|
987
|
+
* @param {Number} opts.limit Number of documents returned per page (default to 500)
|
|
988
|
+
* @param {Number} opts.offset Index of the first document in the page (default to 0)
|
|
989
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetTransacEmailsList} and HTTP response
|
|
990
|
+
*/
|
|
991
|
+
this.getTransacEmailsListWithHttpInfo = function(opts) {
|
|
992
|
+
opts = opts || {};
|
|
993
|
+
var postBody = null;
|
|
994
|
+
|
|
995
|
+
|
|
996
|
+
var pathParams = {
|
|
997
|
+
};
|
|
998
|
+
var queryParams = {
|
|
999
|
+
'email': opts['email'],
|
|
1000
|
+
'templateId': opts['templateId'],
|
|
1001
|
+
'messageId': opts['messageId'],
|
|
1002
|
+
'startDate': opts['startDate'],
|
|
1003
|
+
'endDate': opts['endDate'],
|
|
1004
|
+
'sort': opts['sort'],
|
|
1005
|
+
'limit': opts['limit'],
|
|
1006
|
+
'offset': opts['offset'],
|
|
1007
|
+
};
|
|
1008
|
+
var collectionQueryParams = {
|
|
1009
|
+
};
|
|
1010
|
+
var headerParams = {
|
|
1011
|
+
};
|
|
1012
|
+
var formParams = {
|
|
1013
|
+
};
|
|
1014
|
+
|
|
1015
|
+
var authNames = ['api-key', 'partner-key'];
|
|
1016
|
+
var contentTypes = ['application/json'];
|
|
1017
|
+
var accepts = ['application/json'];
|
|
1018
|
+
var returnType = GetTransacEmailsList;
|
|
1019
|
+
|
|
1020
|
+
return this.apiClient.callApi(
|
|
1021
|
+
'/smtp/emails', 'GET',
|
|
1022
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
1023
|
+
authNames, contentTypes, accepts, returnType
|
|
1024
|
+
);
|
|
1025
|
+
}
|
|
1026
|
+
|
|
1027
|
+
/**
|
|
1028
|
+
* Get the list of transactional emails on the basis of allowed filters
|
|
1029
|
+
* This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters.
|
|
1030
|
+
* @param {Object} opts Optional parameters
|
|
1031
|
+
* @param {String} opts.email Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
|
|
1032
|
+
* @param {Number} opts.templateId Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
|
|
1033
|
+
* @param {String} opts.messageId Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
|
|
1034
|
+
* @param {String} opts.startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
|
|
1035
|
+
* @param {String} opts.endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
|
|
1036
|
+
* @param {module:model/String} opts.sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
|
1037
|
+
* @param {Number} opts.limit Number of documents returned per page (default to 500)
|
|
1038
|
+
* @param {Number} opts.offset Index of the first document in the page (default to 0)
|
|
1039
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetTransacEmailsList}
|
|
1040
|
+
*/
|
|
1041
|
+
this.getTransacEmailsList = function(opts) {
|
|
1042
|
+
return this.getTransacEmailsListWithHttpInfo(opts)
|
|
1043
|
+
.then(function(response_and_data) {
|
|
1044
|
+
return response_and_data.data;
|
|
1045
|
+
});
|
|
1046
|
+
}
|
|
1047
|
+
|
|
1048
|
+
|
|
1049
|
+
/**
|
|
1050
|
+
* Send a template to your test list
|
|
1051
|
+
* @param {Number} templateId Id of the template
|
|
1052
|
+
* @param {module:model/SendTestEmail} sendTestEmail
|
|
1053
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
1054
|
+
*/
|
|
1055
|
+
this.sendTestTemplateWithHttpInfo = function(templateId, sendTestEmail) {
|
|
1056
|
+
var postBody = sendTestEmail;
|
|
1057
|
+
|
|
1058
|
+
// verify the required parameter 'templateId' is set
|
|
1059
|
+
if (templateId === undefined || templateId === null) {
|
|
1060
|
+
throw new Error("Missing the required parameter 'templateId' when calling sendTestTemplate");
|
|
1061
|
+
}
|
|
1062
|
+
|
|
1063
|
+
// verify the required parameter 'sendTestEmail' is set
|
|
1064
|
+
if (sendTestEmail === undefined || sendTestEmail === null) {
|
|
1065
|
+
throw new Error("Missing the required parameter 'sendTestEmail' when calling sendTestTemplate");
|
|
1066
|
+
}
|
|
1067
|
+
|
|
1068
|
+
|
|
1069
|
+
var pathParams = {
|
|
1070
|
+
'templateId': templateId
|
|
1071
|
+
};
|
|
1072
|
+
var queryParams = {
|
|
1073
|
+
};
|
|
1074
|
+
var collectionQueryParams = {
|
|
1075
|
+
};
|
|
1076
|
+
var headerParams = {
|
|
1077
|
+
};
|
|
1078
|
+
var formParams = {
|
|
1079
|
+
};
|
|
1080
|
+
|
|
1081
|
+
var authNames = ['api-key', 'partner-key'];
|
|
1082
|
+
var contentTypes = ['application/json'];
|
|
1083
|
+
var accepts = ['application/json'];
|
|
1084
|
+
var returnType = null;
|
|
1085
|
+
|
|
1086
|
+
return this.apiClient.callApi(
|
|
1087
|
+
'/smtp/templates/{templateId}/sendTest', 'POST',
|
|
1088
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
1089
|
+
authNames, contentTypes, accepts, returnType
|
|
1090
|
+
);
|
|
1091
|
+
}
|
|
1092
|
+
|
|
1093
|
+
/**
|
|
1094
|
+
* Send a template to your test list
|
|
1095
|
+
* @param {Number} templateId Id of the template
|
|
1096
|
+
* @param {module:model/SendTestEmail} sendTestEmail
|
|
1097
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
1098
|
+
*/
|
|
1099
|
+
this.sendTestTemplate = function(templateId, sendTestEmail) {
|
|
1100
|
+
return this.sendTestTemplateWithHttpInfo(templateId, sendTestEmail)
|
|
1101
|
+
.then(function(response_and_data) {
|
|
1102
|
+
return response_and_data.data;
|
|
1103
|
+
});
|
|
1104
|
+
}
|
|
1105
|
+
|
|
1106
|
+
|
|
1107
|
+
/**
|
|
1108
|
+
* Send a transactional email
|
|
1109
|
+
* @param {module:model/SendSmtpEmail} sendSmtpEmail Values to send a transactional email
|
|
1110
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateSmtpEmail} and HTTP response
|
|
1111
|
+
*/
|
|
1112
|
+
this.sendTransacEmailWithHttpInfo = function(sendSmtpEmail) {
|
|
1113
|
+
var postBody = sendSmtpEmail;
|
|
1114
|
+
|
|
1115
|
+
// verify the required parameter 'sendSmtpEmail' is set
|
|
1116
|
+
if (sendSmtpEmail === undefined || sendSmtpEmail === null) {
|
|
1117
|
+
throw new Error("Missing the required parameter 'sendSmtpEmail' when calling sendTransacEmail");
|
|
1118
|
+
}
|
|
1119
|
+
|
|
1120
|
+
|
|
1121
|
+
var pathParams = {
|
|
1122
|
+
};
|
|
1123
|
+
var queryParams = {
|
|
1124
|
+
};
|
|
1125
|
+
var collectionQueryParams = {
|
|
1126
|
+
};
|
|
1127
|
+
var headerParams = {
|
|
1128
|
+
};
|
|
1129
|
+
var formParams = {
|
|
1130
|
+
};
|
|
1131
|
+
|
|
1132
|
+
var authNames = ['api-key', 'partner-key'];
|
|
1133
|
+
var contentTypes = ['application/json'];
|
|
1134
|
+
var accepts = ['application/json'];
|
|
1135
|
+
var returnType = CreateSmtpEmail;
|
|
1136
|
+
|
|
1137
|
+
return this.apiClient.callApi(
|
|
1138
|
+
'/smtp/email', 'POST',
|
|
1139
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
1140
|
+
authNames, contentTypes, accepts, returnType
|
|
1141
|
+
);
|
|
1142
|
+
}
|
|
1143
|
+
|
|
1144
|
+
/**
|
|
1145
|
+
* Send a transactional email
|
|
1146
|
+
* @param {module:model/SendSmtpEmail} sendSmtpEmail Values to send a transactional email
|
|
1147
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateSmtpEmail}
|
|
1148
|
+
*/
|
|
1149
|
+
this.sendTransacEmail = function(sendSmtpEmail) {
|
|
1150
|
+
return this.sendTransacEmailWithHttpInfo(sendSmtpEmail)
|
|
1151
|
+
.then(function(response_and_data) {
|
|
1152
|
+
return response_and_data.data;
|
|
1153
|
+
});
|
|
1154
|
+
}
|
|
1155
|
+
|
|
1156
|
+
|
|
1157
|
+
/**
|
|
1158
|
+
* Unblock or resubscribe a transactional contact
|
|
1159
|
+
* @param {String} email contact email (urlencoded) to unblock.
|
|
1160
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
1161
|
+
*/
|
|
1162
|
+
this.smtpBlockedContactsEmailDeleteWithHttpInfo = function(email) {
|
|
1163
|
+
var postBody = null;
|
|
1164
|
+
|
|
1165
|
+
// verify the required parameter 'email' is set
|
|
1166
|
+
if (email === undefined || email === null) {
|
|
1167
|
+
throw new Error("Missing the required parameter 'email' when calling smtpBlockedContactsEmailDelete");
|
|
1168
|
+
}
|
|
1169
|
+
|
|
1170
|
+
|
|
1171
|
+
var pathParams = {
|
|
1172
|
+
'email': email
|
|
1173
|
+
};
|
|
1174
|
+
var queryParams = {
|
|
1175
|
+
};
|
|
1176
|
+
var collectionQueryParams = {
|
|
1177
|
+
};
|
|
1178
|
+
var headerParams = {
|
|
1179
|
+
};
|
|
1180
|
+
var formParams = {
|
|
1181
|
+
};
|
|
1182
|
+
|
|
1183
|
+
var authNames = ['api-key', 'partner-key'];
|
|
1184
|
+
var contentTypes = ['application/json'];
|
|
1185
|
+
var accepts = ['application/json'];
|
|
1186
|
+
var returnType = null;
|
|
1187
|
+
|
|
1188
|
+
return this.apiClient.callApi(
|
|
1189
|
+
'/smtp/blockedContacts/{email}', 'DELETE',
|
|
1190
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
1191
|
+
authNames, contentTypes, accepts, returnType
|
|
1192
|
+
);
|
|
1193
|
+
}
|
|
1194
|
+
|
|
1195
|
+
/**
|
|
1196
|
+
* Unblock or resubscribe a transactional contact
|
|
1197
|
+
* @param {String} email contact email (urlencoded) to unblock.
|
|
1198
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
1199
|
+
*/
|
|
1200
|
+
this.smtpBlockedContactsEmailDelete = function(email) {
|
|
1201
|
+
return this.smtpBlockedContactsEmailDeleteWithHttpInfo(email)
|
|
1202
|
+
.then(function(response_and_data) {
|
|
1203
|
+
return response_and_data.data;
|
|
1204
|
+
});
|
|
1205
|
+
}
|
|
1206
|
+
|
|
1207
|
+
|
|
1208
|
+
/**
|
|
1209
|
+
* Delete an SMTP transactional log
|
|
1210
|
+
* @param {String} messageId MessageId of the transactional log to delete
|
|
1211
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
1212
|
+
*/
|
|
1213
|
+
this.smtpLogMessageIdDeleteWithHttpInfo = function(messageId) {
|
|
1214
|
+
var postBody = null;
|
|
1215
|
+
|
|
1216
|
+
// verify the required parameter 'messageId' is set
|
|
1217
|
+
if (messageId === undefined || messageId === null) {
|
|
1218
|
+
throw new Error("Missing the required parameter 'messageId' when calling smtpLogMessageIdDelete");
|
|
1219
|
+
}
|
|
1220
|
+
|
|
1221
|
+
|
|
1222
|
+
var pathParams = {
|
|
1223
|
+
'messageId': messageId
|
|
1224
|
+
};
|
|
1225
|
+
var queryParams = {
|
|
1226
|
+
};
|
|
1227
|
+
var collectionQueryParams = {
|
|
1228
|
+
};
|
|
1229
|
+
var headerParams = {
|
|
1230
|
+
};
|
|
1231
|
+
var formParams = {
|
|
1232
|
+
};
|
|
1233
|
+
|
|
1234
|
+
var authNames = ['api-key', 'partner-key'];
|
|
1235
|
+
var contentTypes = ['application/json'];
|
|
1236
|
+
var accepts = ['application/json'];
|
|
1237
|
+
var returnType = null;
|
|
1238
|
+
|
|
1239
|
+
return this.apiClient.callApi(
|
|
1240
|
+
'/smtp/log/{messageId}', 'DELETE',
|
|
1241
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
1242
|
+
authNames, contentTypes, accepts, returnType
|
|
1243
|
+
);
|
|
1244
|
+
}
|
|
1245
|
+
|
|
1246
|
+
/**
|
|
1247
|
+
* Delete an SMTP transactional log
|
|
1248
|
+
* @param {String} messageId MessageId of the transactional log to delete
|
|
1249
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
1250
|
+
*/
|
|
1251
|
+
this.smtpLogMessageIdDelete = function(messageId) {
|
|
1252
|
+
return this.smtpLogMessageIdDeleteWithHttpInfo(messageId)
|
|
1253
|
+
.then(function(response_and_data) {
|
|
1254
|
+
return response_and_data.data;
|
|
1255
|
+
});
|
|
1256
|
+
}
|
|
1257
|
+
|
|
1258
|
+
|
|
1259
|
+
/**
|
|
1260
|
+
* Update an email template
|
|
1261
|
+
* @param {Number} templateId id of the template
|
|
1262
|
+
* @param {module:model/UpdateSmtpTemplate} smtpTemplate values to update in transactional email template
|
|
1263
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
1264
|
+
*/
|
|
1265
|
+
this.updateSmtpTemplateWithHttpInfo = function(templateId, smtpTemplate) {
|
|
1266
|
+
var postBody = smtpTemplate;
|
|
1267
|
+
|
|
1268
|
+
// verify the required parameter 'templateId' is set
|
|
1269
|
+
if (templateId === undefined || templateId === null) {
|
|
1270
|
+
throw new Error("Missing the required parameter 'templateId' when calling updateSmtpTemplate");
|
|
1271
|
+
}
|
|
1272
|
+
|
|
1273
|
+
// verify the required parameter 'smtpTemplate' is set
|
|
1274
|
+
if (smtpTemplate === undefined || smtpTemplate === null) {
|
|
1275
|
+
throw new Error("Missing the required parameter 'smtpTemplate' when calling updateSmtpTemplate");
|
|
1276
|
+
}
|
|
1277
|
+
|
|
1278
|
+
|
|
1279
|
+
var pathParams = {
|
|
1280
|
+
'templateId': templateId
|
|
1281
|
+
};
|
|
1282
|
+
var queryParams = {
|
|
1283
|
+
};
|
|
1284
|
+
var collectionQueryParams = {
|
|
1285
|
+
};
|
|
1286
|
+
var headerParams = {
|
|
1287
|
+
};
|
|
1288
|
+
var formParams = {
|
|
1289
|
+
};
|
|
1290
|
+
|
|
1291
|
+
var authNames = ['api-key', 'partner-key'];
|
|
1292
|
+
var contentTypes = ['application/json'];
|
|
1293
|
+
var accepts = ['application/json'];
|
|
1294
|
+
var returnType = null;
|
|
1295
|
+
|
|
1296
|
+
return this.apiClient.callApi(
|
|
1297
|
+
'/smtp/templates/{templateId}', 'PUT',
|
|
1298
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
1299
|
+
authNames, contentTypes, accepts, returnType
|
|
1300
|
+
);
|
|
1301
|
+
}
|
|
1302
|
+
|
|
1303
|
+
/**
|
|
1304
|
+
* Update an email template
|
|
1305
|
+
* @param {Number} templateId id of the template
|
|
1306
|
+
* @param {module:model/UpdateSmtpTemplate} smtpTemplate values to update in transactional email template
|
|
1307
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
1308
|
+
*/
|
|
1309
|
+
this.updateSmtpTemplate = function(templateId, smtpTemplate) {
|
|
1310
|
+
return this.updateSmtpTemplateWithHttpInfo(templateId, smtpTemplate)
|
|
1311
|
+
.then(function(response_and_data) {
|
|
1312
|
+
return response_and_data.data;
|
|
1313
|
+
});
|
|
1314
|
+
}
|
|
1315
|
+
};
|
|
1316
|
+
|
|
1317
|
+
return exports;
|
|
1318
|
+
}));
|