@bitblit/ratchet-misc 6.0.146-alpha → 6.0.148-alpha
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/package.json +5 -4
- package/src/brevo/brevo-keys.ts +7 -0
- package/src/brevo/brevo-mail-sending-provider.ts +49 -0
- package/src/brevo/brevo-ratchet.spec.ts +35 -0
- package/src/brevo/brevo-ratchet.ts +50 -0
- package/src/brevo/generated/.openapi-generator/FILES +208 -0
- package/src/brevo/generated/.openapi-generator/VERSION +1 -0
- package/src/brevo/generated/.openapi-generator-ignore +23 -0
- package/src/brevo/generated/apis/AccountApi.ts +76 -0
- package/src/brevo/generated/apis/AttributesApi.ts +366 -0
- package/src/brevo/generated/apis/ContactsApi.ts +2295 -0
- package/src/brevo/generated/apis/EmailCampaignsApi.ts +1130 -0
- package/src/brevo/generated/apis/FoldersApi.ts +502 -0
- package/src/brevo/generated/apis/ListsApi.ts +770 -0
- package/src/brevo/generated/apis/ProcessApi.ts +165 -0
- package/src/brevo/generated/apis/ResellerApi.ts +1330 -0
- package/src/brevo/generated/apis/SMSCampaignsApi.ts +839 -0
- package/src/brevo/generated/apis/SMTPApi.ts +1674 -0
- package/src/brevo/generated/apis/SendersApi.ts +425 -0
- package/src/brevo/generated/apis/TransactionalSMSApi.ts +433 -0
- package/src/brevo/generated/apis/WebhooksApi.ts +393 -0
- package/src/brevo/generated/apis/WhatsAppCampaignsApi.ts +371 -0
- package/src/brevo/generated/models/AbTestCampaignResult.ts +142 -0
- package/src/brevo/generated/models/AbTestCampaignResultClickedLinks.ts +73 -0
- package/src/brevo/generated/models/AbTestCampaignResultStatistics.ts +109 -0
- package/src/brevo/generated/models/AbTestVersionClicksInner.ts +79 -0
- package/src/brevo/generated/models/AbTestVersionStats.ts +70 -0
- package/src/brevo/generated/models/AddChildDomain.ts +62 -0
- package/src/brevo/generated/models/AddContactToList.ts +62 -0
- package/src/brevo/generated/models/AddCredits.ts +70 -0
- package/src/brevo/generated/models/BlockDomain.ts +61 -0
- package/src/brevo/generated/models/ComponentItems.ts +70 -0
- package/src/brevo/generated/models/CreateAttribute.ts +95 -0
- package/src/brevo/generated/models/CreateAttributeEnumerationInner.ts +70 -0
- package/src/brevo/generated/models/CreateChild.ts +120 -0
- package/src/brevo/generated/models/CreateContact.ts +110 -0
- package/src/brevo/generated/models/CreateDoiContact.ts +106 -0
- package/src/brevo/generated/models/CreateEmailCampaign.ts +293 -0
- package/src/brevo/generated/models/CreateEmailCampaignRecipients.ts +70 -0
- package/src/brevo/generated/models/CreateEmailCampaignSender.ts +78 -0
- package/src/brevo/generated/models/CreateList.ts +70 -0
- package/src/brevo/generated/models/CreateModel.ts +61 -0
- package/src/brevo/generated/models/CreateReseller.ts +71 -0
- package/src/brevo/generated/models/CreateSender.ts +82 -0
- package/src/brevo/generated/models/CreateSenderIpsInner.ts +80 -0
- package/src/brevo/generated/models/CreateSenderModel.ts +79 -0
- package/src/brevo/generated/models/CreateSmsCampaign.ts +99 -0
- package/src/brevo/generated/models/CreateSmsCampaignRecipients.ts +71 -0
- package/src/brevo/generated/models/CreateSmtpEmail.ts +61 -0
- package/src/brevo/generated/models/CreateSmtpTemplate.ts +139 -0
- package/src/brevo/generated/models/CreateSmtpTemplateSender.ts +78 -0
- package/src/brevo/generated/models/CreateUpdateContactModel.ts +62 -0
- package/src/brevo/generated/models/CreateUpdateFolder.ts +62 -0
- package/src/brevo/generated/models/CreateWebhook.ts +119 -0
- package/src/brevo/generated/models/CreatedProcessId.ts +61 -0
- package/src/brevo/generated/models/DeleteHardbounces.ts +78 -0
- package/src/brevo/generated/models/EmailExportRecipients.ts +86 -0
- package/src/brevo/generated/models/ErrorModel.ts +92 -0
- package/src/brevo/generated/models/GetAccount.ts +138 -0
- package/src/brevo/generated/models/GetAccountAllOfMarketingAutomation.ts +74 -0
- package/src/brevo/generated/models/GetAccountAllOfPlan.ts +124 -0
- package/src/brevo/generated/models/GetAccountAllOfRelay.ts +73 -0
- package/src/brevo/generated/models/GetAccountAllOfRelayData.ts +79 -0
- package/src/brevo/generated/models/GetAggregatedReport.ts +169 -0
- package/src/brevo/generated/models/GetAttributes.ts +64 -0
- package/src/brevo/generated/models/GetAttributesAttributesInner.ts +129 -0
- package/src/brevo/generated/models/GetAttributesAttributesInnerEnumerationInner.ts +73 -0
- package/src/brevo/generated/models/GetBlockedDomains.ts +61 -0
- package/src/brevo/generated/models/GetCampaignOverview.ts +183 -0
- package/src/brevo/generated/models/GetCampaignRecipients.ts +70 -0
- package/src/brevo/generated/models/GetCampaignStats.ts +177 -0
- package/src/brevo/generated/models/GetChildAccountCreationStatus.ts +61 -0
- package/src/brevo/generated/models/GetChildDomain.ts +70 -0
- package/src/brevo/generated/models/GetChildInfo.ts +137 -0
- package/src/brevo/generated/models/GetChildInfoAllOfApiKeys.ts +75 -0
- package/src/brevo/generated/models/GetChildInfoAllOfApiKeysV2.ts +70 -0
- package/src/brevo/generated/models/GetChildInfoAllOfApiKeysV3.ts +70 -0
- package/src/brevo/generated/models/GetChildInfoAllOfCredits.ts +70 -0
- package/src/brevo/generated/models/GetChildInfoAllOfStatistics.ts +78 -0
- package/src/brevo/generated/models/GetChildrenList.ts +73 -0
- package/src/brevo/generated/models/GetChildrenListChildrenInner.ts +145 -0
- package/src/brevo/generated/models/GetClient.ts +88 -0
- package/src/brevo/generated/models/GetContactCampaignStats.ts +168 -0
- package/src/brevo/generated/models/GetContactCampaignStatsClickedInner.ts +79 -0
- package/src/brevo/generated/models/GetContactCampaignStatsOpenedInner.ts +91 -0
- package/src/brevo/generated/models/GetContactCampaignStatsTransacAttributesInner.ts +82 -0
- package/src/brevo/generated/models/GetContactCampaignStatsUnsubscriptions.ts +92 -0
- package/src/brevo/generated/models/GetContactDetails.ts +133 -0
- package/src/brevo/generated/models/GetContacts.ts +73 -0
- package/src/brevo/generated/models/GetDeviceBrowserStats.ts +88 -0
- package/src/brevo/generated/models/GetEmailCampaign.ts +348 -0
- package/src/brevo/generated/models/GetEmailCampaigns.ts +73 -0
- package/src/brevo/generated/models/GetEmailCampaignsCampaignsInner.ts +348 -0
- package/src/brevo/generated/models/GetEmailEventReport.ts +64 -0
- package/src/brevo/generated/models/GetEmailEventReportEventsInner.ts +157 -0
- package/src/brevo/generated/models/GetExtendedCampaignOverview.ts +326 -0
- package/src/brevo/generated/models/GetExtendedCampaignOverviewAllOfSender.ts +81 -0
- package/src/brevo/generated/models/GetExtendedCampaignStats.ts +132 -0
- package/src/brevo/generated/models/GetExtendedClient.ts +100 -0
- package/src/brevo/generated/models/GetExtendedClientAllOfAddress.ts +88 -0
- package/src/brevo/generated/models/GetExtendedContactDetails.ts +147 -0
- package/src/brevo/generated/models/GetExtendedContactDetailsAllOfStatistics.ts +168 -0
- package/src/brevo/generated/models/GetExtendedContactDetailsAllOfStatisticsClicked.ts +79 -0
- package/src/brevo/generated/models/GetExtendedContactDetailsAllOfStatisticsLinks.ts +91 -0
- package/src/brevo/generated/models/GetExtendedContactDetailsAllOfStatisticsMessagesSent.ts +77 -0
- package/src/brevo/generated/models/GetExtendedContactDetailsAllOfStatisticsOpened.ts +91 -0
- package/src/brevo/generated/models/GetExtendedContactDetailsAllOfStatisticsUnsubscriptions.ts +96 -0
- package/src/brevo/generated/models/GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsAdminUnsubscription.ts +78 -0
- package/src/brevo/generated/models/GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsUserUnsubscription.ts +87 -0
- package/src/brevo/generated/models/GetExtendedList.ts +129 -0
- package/src/brevo/generated/models/GetExtendedListAllOfCampaignStats.ts +73 -0
- package/src/brevo/generated/models/GetFolder.ts +97 -0
- package/src/brevo/generated/models/GetFolderLists.ts +73 -0
- package/src/brevo/generated/models/GetFolders.ts +72 -0
- package/src/brevo/generated/models/GetIp.ts +88 -0
- package/src/brevo/generated/models/GetIpFromSender.ts +88 -0
- package/src/brevo/generated/models/GetIps.ts +64 -0
- package/src/brevo/generated/models/GetIpsFromSender.ts +64 -0
- package/src/brevo/generated/models/GetList.ts +88 -0
- package/src/brevo/generated/models/GetLists.ts +73 -0
- package/src/brevo/generated/models/GetListsListsInner.ts +97 -0
- package/src/brevo/generated/models/GetProcess.ts +99 -0
- package/src/brevo/generated/models/GetProcesses.ts +73 -0
- package/src/brevo/generated/models/GetReports.ts +64 -0
- package/src/brevo/generated/models/GetReportsReportsInner.ts +169 -0
- package/src/brevo/generated/models/GetSegments.ts +72 -0
- package/src/brevo/generated/models/GetSegmentsSegments.ts +86 -0
- package/src/brevo/generated/models/GetSendersList.ts +64 -0
- package/src/brevo/generated/models/GetSendersListSendersInner.ts +103 -0
- package/src/brevo/generated/models/GetSendersListSendersInnerIpsInner.ts +82 -0
- package/src/brevo/generated/models/GetSharedTemplateUrl.ts +61 -0
- package/src/brevo/generated/models/GetSmsCampaign.ts +160 -0
- package/src/brevo/generated/models/GetSmsCampaignOverview.ts +137 -0
- package/src/brevo/generated/models/GetSmsCampaignStats.ts +115 -0
- package/src/brevo/generated/models/GetSmsCampaigns.ts +73 -0
- package/src/brevo/generated/models/GetSmsCampaignsCampaignsInner.ts +160 -0
- package/src/brevo/generated/models/GetSmsEventReport.ts +64 -0
- package/src/brevo/generated/models/GetSmsEventReportEventsInner.ts +131 -0
- package/src/brevo/generated/models/GetSmtpTemplateOverview.ts +172 -0
- package/src/brevo/generated/models/GetSmtpTemplateOverviewSender.ts +78 -0
- package/src/brevo/generated/models/GetSmtpTemplates.ts +72 -0
- package/src/brevo/generated/models/GetSsoToken.ts +61 -0
- package/src/brevo/generated/models/GetStatsByDevice.ts +88 -0
- package/src/brevo/generated/models/GetTransacAggregatedSmsReport.ts +142 -0
- package/src/brevo/generated/models/GetTransacBlockedContacts.ts +75 -0
- package/src/brevo/generated/models/GetTransacBlockedContactsContactsInner.ts +97 -0
- package/src/brevo/generated/models/GetTransacBlockedContactsContactsInnerReason.ts +86 -0
- package/src/brevo/generated/models/GetTransacEmailContent.ts +118 -0
- package/src/brevo/generated/models/GetTransacEmailContentEventsInner.ts +70 -0
- package/src/brevo/generated/models/GetTransacEmailsList.ts +72 -0
- package/src/brevo/generated/models/GetTransacEmailsListTransactionalEmailsInner.ts +126 -0
- package/src/brevo/generated/models/GetTransacSmsReport.ts +64 -0
- package/src/brevo/generated/models/GetTransacSmsReportReportsInner.ts +142 -0
- package/src/brevo/generated/models/GetWATemplates.ts +73 -0
- package/src/brevo/generated/models/GetWATemplatesTemplatesInner.ts +125 -0
- package/src/brevo/generated/models/GetWebhook.ts +124 -0
- package/src/brevo/generated/models/GetWebhooks.ts +64 -0
- package/src/brevo/generated/models/GetWhatsappCampaignOverview.ts +152 -0
- package/src/brevo/generated/models/GetWhatsappCampaigns.ts +75 -0
- package/src/brevo/generated/models/GetWhatsappCampaignsCampaignsInner.ts +169 -0
- package/src/brevo/generated/models/ManageIp.ts +62 -0
- package/src/brevo/generated/models/PostContactInfo.ts +64 -0
- package/src/brevo/generated/models/PostContactInfoContacts.ts +86 -0
- package/src/brevo/generated/models/PostSendFailed.ts +96 -0
- package/src/brevo/generated/models/PostSendSmsTestFailed.ts +88 -0
- package/src/brevo/generated/models/RemainingCreditModel.ts +75 -0
- package/src/brevo/generated/models/RemainingCreditModelChild.ts +70 -0
- package/src/brevo/generated/models/RemainingCreditModelReseller.ts +70 -0
- package/src/brevo/generated/models/RemoveContactFromList.ts +70 -0
- package/src/brevo/generated/models/RemoveCredits.ts +70 -0
- package/src/brevo/generated/models/RequestContactExport.ts +94 -0
- package/src/brevo/generated/models/RequestContactExportCustomContactFilter.ts +141 -0
- package/src/brevo/generated/models/RequestContactImport.ts +136 -0
- package/src/brevo/generated/models/RequestContactImportNewList.ts +70 -0
- package/src/brevo/generated/models/RequestSmsRecipientExport.ts +84 -0
- package/src/brevo/generated/models/SendEmail.ts +129 -0
- package/src/brevo/generated/models/SendEmailAttachmentInner.ts +70 -0
- package/src/brevo/generated/models/SendReport.ts +86 -0
- package/src/brevo/generated/models/SendReportEmail.ts +70 -0
- package/src/brevo/generated/models/SendSms.ts +96 -0
- package/src/brevo/generated/models/SendSmtpEmail.ts +171 -0
- package/src/brevo/generated/models/SendSmtpEmailAttachmentInner.ts +78 -0
- package/src/brevo/generated/models/SendSmtpEmailBccInner.ts +71 -0
- package/src/brevo/generated/models/SendSmtpEmailCcInner.ts +71 -0
- package/src/brevo/generated/models/SendSmtpEmailReplyTo.ts +71 -0
- package/src/brevo/generated/models/SendSmtpEmailSender.ts +71 -0
- package/src/brevo/generated/models/SendSmtpEmailToInner.ts +71 -0
- package/src/brevo/generated/models/SendTemplateEmail.ts +61 -0
- package/src/brevo/generated/models/SendTestEmail.ts +62 -0
- package/src/brevo/generated/models/SendTestSms.ts +62 -0
- package/src/brevo/generated/models/SendTransacSms.ts +122 -0
- package/src/brevo/generated/models/UpdateAttribute.ts +74 -0
- package/src/brevo/generated/models/UpdateAttributeEnumerationInner.ts +70 -0
- package/src/brevo/generated/models/UpdateCampaignStatus.ts +77 -0
- package/src/brevo/generated/models/UpdateChild.ts +94 -0
- package/src/brevo/generated/models/UpdateChildAccountStatus.ts +86 -0
- package/src/brevo/generated/models/UpdateChildDomain.ts +62 -0
- package/src/brevo/generated/models/UpdateContact.ts +102 -0
- package/src/brevo/generated/models/UpdateEmailCampaign.ts +291 -0
- package/src/brevo/generated/models/UpdateEmailCampaignRecipients.ts +70 -0
- package/src/brevo/generated/models/UpdateEmailCampaignSender.ts +78 -0
- package/src/brevo/generated/models/UpdateList.ts +70 -0
- package/src/brevo/generated/models/UpdateSender.ts +80 -0
- package/src/brevo/generated/models/UpdateSmsCampaign.ts +96 -0
- package/src/brevo/generated/models/UpdateSmtpTemplate.ts +136 -0
- package/src/brevo/generated/models/UpdateSmtpTemplateSender.ts +78 -0
- package/src/brevo/generated/models/UpdateWebhook.ts +100 -0
- package/src/brevo/generated/models/UploadImageToGallery.ts +71 -0
- package/src/brevo/generated/models/VariablesItems.ts +78 -0
- package/src/brevo/generated/models/WhatsappCampStats.ts +97 -0
- package/src/brevo/generated/models/WhatsappCampTemplate.ts +146 -0
- package/src/brevo/generated/models/index.ts +189 -0
- package/src/brevo/generated/runtime.ts +455 -0
- package/src/build/ratchet-misc-info.ts +19 -0
- package/src/handlebars/handlebars-ratchet.spec.ts +117 -0
- package/src/handlebars/handlebars-ratchet.ts +151 -0
- package/src/handlebars/remote-handlebars-template-renderer.ts +87 -0
- package/src/model-validator/model-validator.spec.ts +43 -0
- package/src/model-validator/model-validator.ts +67 -0
- package/src/rxjs/observable-ratchet.spec.ts +21 -0
- package/src/rxjs/observable-ratchet.ts +27 -0
- package/src/rxjs/rxjs-ratchet.spec.ts +22 -0
- package/src/rxjs/rxjs-ratchet.ts +44 -0
- package/src/sobol/generated/.openapi-generator/FILES +53 -0
- package/src/sobol/generated/.openapi-generator/VERSION +1 -0
- package/src/sobol/generated/.openapi-generator-ignore +23 -0
- package/src/sobol/generated/apis/AgreementsApi.ts +656 -0
- package/src/sobol/generated/apis/CustomFieldValuesApi.ts +412 -0
- package/src/sobol/generated/apis/CustomFieldsApi.ts +460 -0
- package/src/sobol/generated/apis/GoalsApi.ts +565 -0
- package/src/sobol/generated/apis/RoleAssignmentsApi.ts +289 -0
- package/src/sobol/generated/apis/RolesApi.ts +736 -0
- package/src/sobol/generated/apis/TeamsApi.ts +748 -0
- package/src/sobol/generated/apis/UsersApi.ts +640 -0
- package/src/sobol/generated/apis/index.ts +8 -0
- package/src/sobol/generated/index.ts +3 -0
- package/src/sobol/generated/models/Address.ts +220 -0
- package/src/sobol/generated/models/AddressTypeInternalEnum.ts +35 -0
- package/src/sobol/generated/models/Agreement.ts +281 -0
- package/src/sobol/generated/models/AgreementOwnersInner.ts +80 -0
- package/src/sobol/generated/models/AgreementSignatoriesInner.ts +78 -0
- package/src/sobol/generated/models/CustomField.ts +265 -0
- package/src/sobol/generated/models/CustomFieldBadgeConfig.ts +67 -0
- package/src/sobol/generated/models/CustomFieldBadgeConfigOptionsValue.ts +105 -0
- package/src/sobol/generated/models/CustomFieldBadgeContent.ts +67 -0
- package/src/sobol/generated/models/CustomFieldBadgeContentBadgesInner.ts +73 -0
- package/src/sobol/generated/models/CustomFieldConfig.ts +88 -0
- package/src/sobol/generated/models/CustomFieldMultiSelectDropDownConfig.ts +70 -0
- package/src/sobol/generated/models/CustomFieldMultiSelectDropDownContent.ts +72 -0
- package/src/sobol/generated/models/CustomFieldMultiSelectDropDownContentSelectedOptions.ts +77 -0
- package/src/sobol/generated/models/CustomFieldSingleSelectDropDownConfig.ts +70 -0
- package/src/sobol/generated/models/CustomFieldSingleSelectDropDownConfigOptionsValue.ts +75 -0
- package/src/sobol/generated/models/CustomFieldSingleSelectDropDownContent.ts +72 -0
- package/src/sobol/generated/models/CustomFieldSingleSelectDropDownContentSelectedOptions.ts +77 -0
- package/src/sobol/generated/models/CustomFieldTextConfig.ts +62 -0
- package/src/sobol/generated/models/CustomFieldTextContent.ts +62 -0
- package/src/sobol/generated/models/CustomFieldValue.ts +249 -0
- package/src/sobol/generated/models/CustomFieldValueContent.ts +88 -0
- package/src/sobol/generated/models/FeatureToggle.ts +123 -0
- package/src/sobol/generated/models/GlobalIdentity.ts +218 -0
- package/src/sobol/generated/models/GlobalUserSettings.ts +187 -0
- package/src/sobol/generated/models/Goal.ts +322 -0
- package/src/sobol/generated/models/GoalOwnersInner.ts +80 -0
- package/src/sobol/generated/models/GoalParentGoal.ts +78 -0
- package/src/sobol/generated/models/GoalValue.ts +178 -0
- package/src/sobol/generated/models/LocalIdentity.ts +220 -0
- package/src/sobol/generated/models/ObjectRef.ts +82 -0
- package/src/sobol/generated/models/Role.ts +258 -0
- package/src/sobol/generated/models/RoleAccountableTo.ts +78 -0
- package/src/sobol/generated/models/RoleAssignment.ts +202 -0
- package/src/sobol/generated/models/RoleAssignmentsInner.ts +78 -0
- package/src/sobol/generated/models/RoleContributesTo.ts +78 -0
- package/src/sobol/generated/models/Team.ts +273 -0
- package/src/sobol/generated/models/TeamOwnersInner.ts +79 -0
- package/src/sobol/generated/models/User.ts +396 -0
- package/src/sobol/generated/models/UserLocalIdentitiesInner.ts +78 -0
- package/src/sobol/generated/models/index.ts +40 -0
- package/src/sobol/generated/runtime.ts +455 -0
|
@@ -0,0 +1,1674 @@
|
|
|
1
|
+
/* eslint-disable */
|
|
2
|
+
/**
|
|
3
|
+
* SendinBlue API
|
|
4
|
+
* SendinBlue 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/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
|
5
|
+
*
|
|
6
|
+
* The version of the OpenAPI document: 3.0.0
|
|
7
|
+
* Contact: contact@sendinblue.com
|
|
8
|
+
*
|
|
9
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
10
|
+
* https://openapi-generator.tech
|
|
11
|
+
* Do not edit the class manually.
|
|
12
|
+
*/
|
|
13
|
+
|
|
14
|
+
import * as runtime from '../runtime.js';
|
|
15
|
+
import type {
|
|
16
|
+
BlockDomain,
|
|
17
|
+
CreateModel,
|
|
18
|
+
CreateSmtpEmail,
|
|
19
|
+
CreateSmtpTemplate,
|
|
20
|
+
DeleteHardbounces,
|
|
21
|
+
GetAggregatedReport,
|
|
22
|
+
GetBlockedDomains,
|
|
23
|
+
GetEmailEventReport,
|
|
24
|
+
GetReports,
|
|
25
|
+
GetSmtpTemplateOverview,
|
|
26
|
+
GetSmtpTemplates,
|
|
27
|
+
GetTransacBlockedContacts,
|
|
28
|
+
GetTransacEmailContent,
|
|
29
|
+
GetTransacEmailsList,
|
|
30
|
+
SendEmail,
|
|
31
|
+
SendSmtpEmail,
|
|
32
|
+
SendTemplateEmail,
|
|
33
|
+
SendTestEmail,
|
|
34
|
+
UpdateSmtpTemplate,
|
|
35
|
+
} from '../models/index.js';
|
|
36
|
+
import {
|
|
37
|
+
BlockDomainToJSON,
|
|
38
|
+
CreateModelFromJSON,
|
|
39
|
+
CreateSmtpEmailFromJSON,
|
|
40
|
+
CreateSmtpTemplateToJSON,
|
|
41
|
+
DeleteHardbouncesToJSON,
|
|
42
|
+
GetAggregatedReportFromJSON,
|
|
43
|
+
GetBlockedDomainsFromJSON,
|
|
44
|
+
GetEmailEventReportFromJSON,
|
|
45
|
+
GetReportsFromJSON,
|
|
46
|
+
GetSmtpTemplateOverviewFromJSON,
|
|
47
|
+
GetSmtpTemplatesFromJSON,
|
|
48
|
+
GetTransacBlockedContactsFromJSON,
|
|
49
|
+
GetTransacEmailContentFromJSON,
|
|
50
|
+
GetTransacEmailsListFromJSON,
|
|
51
|
+
SendEmailToJSON,
|
|
52
|
+
SendSmtpEmailToJSON,
|
|
53
|
+
SendTemplateEmailFromJSON,
|
|
54
|
+
SendTestEmailToJSON,
|
|
55
|
+
UpdateSmtpTemplateToJSON,
|
|
56
|
+
} from '../models/index.js';
|
|
57
|
+
|
|
58
|
+
export interface BlockNewDomainRequest {
|
|
59
|
+
blockDomain: BlockDomain;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
export interface CreateSmtpTemplateRequest {
|
|
63
|
+
smtpTemplate: CreateSmtpTemplate;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
export interface DeleteBlockedDomainRequest {
|
|
67
|
+
domain: string;
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
export interface DeleteHardbouncesRequest {
|
|
71
|
+
deleteHardbounces?: DeleteHardbounces;
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
export interface DeleteSmtpTemplateRequest {
|
|
75
|
+
templateId: number;
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
export interface GetAggregatedSmtpReportRequest {
|
|
79
|
+
startDate?: string;
|
|
80
|
+
endDate?: string;
|
|
81
|
+
days?: number;
|
|
82
|
+
tag?: string;
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
export interface GetEmailEventReportRequest {
|
|
86
|
+
limit?: number;
|
|
87
|
+
offset?: number;
|
|
88
|
+
startDate?: string;
|
|
89
|
+
endDate?: string;
|
|
90
|
+
days?: number;
|
|
91
|
+
email?: string;
|
|
92
|
+
event?: GetEmailEventReportEventEnum;
|
|
93
|
+
tags?: string;
|
|
94
|
+
messageId?: string;
|
|
95
|
+
templateId?: number;
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
export interface GetSmtpReportRequest {
|
|
99
|
+
limit?: number;
|
|
100
|
+
offset?: number;
|
|
101
|
+
startDate?: string;
|
|
102
|
+
endDate?: string;
|
|
103
|
+
days?: number;
|
|
104
|
+
tag?: string;
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
export interface GetSmtpTemplateRequest {
|
|
108
|
+
templateId: number;
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
export interface GetSmtpTemplatesRequest {
|
|
112
|
+
templateStatus?: boolean;
|
|
113
|
+
limit?: number;
|
|
114
|
+
offset?: number;
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
export interface GetTransacBlockedContactsRequest {
|
|
118
|
+
startDate?: string;
|
|
119
|
+
endDate?: string;
|
|
120
|
+
limit?: number;
|
|
121
|
+
offset?: number;
|
|
122
|
+
senders?: Array<string>;
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
export interface GetTransacEmailContentRequest {
|
|
126
|
+
uuid: string;
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
export interface GetTransacEmailsListRequest {
|
|
130
|
+
email?: string;
|
|
131
|
+
templateId?: number;
|
|
132
|
+
messageId?: string;
|
|
133
|
+
startDate?: Date;
|
|
134
|
+
endDate?: Date;
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
export interface SendTemplateRequest {
|
|
138
|
+
templateId: number;
|
|
139
|
+
sendEmail: SendEmail;
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
export interface SendTestTemplateRequest {
|
|
143
|
+
templateId: number;
|
|
144
|
+
sendTestEmail: SendTestEmail;
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
export interface SendTransacEmailRequest {
|
|
148
|
+
sendSmtpEmail: SendSmtpEmail;
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
export interface SmtpBlockedContactsEmailDeleteRequest {
|
|
152
|
+
email: string;
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
export interface SmtpLogMessageIdDeleteRequest {
|
|
156
|
+
messageId: string;
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
export interface UpdateSmtpTemplateRequest {
|
|
160
|
+
templateId: number;
|
|
161
|
+
smtpTemplate: UpdateSmtpTemplate;
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
/**
|
|
165
|
+
* SMTPApi - interface
|
|
166
|
+
*
|
|
167
|
+
* @export
|
|
168
|
+
* @interface SMTPApiInterface
|
|
169
|
+
*/
|
|
170
|
+
export interface SMTPApiInterface {
|
|
171
|
+
/**
|
|
172
|
+
* Blocks a new domain in order to avoid messages being sent to the same
|
|
173
|
+
* @summary Add a new domain to the list of blocked domains
|
|
174
|
+
* @param {BlockDomain} blockDomain
|
|
175
|
+
* @param {*} [options] Override http request option.
|
|
176
|
+
* @throws {RequiredError}
|
|
177
|
+
* @memberof SMTPApiInterface
|
|
178
|
+
*/
|
|
179
|
+
blockNewDomainRaw(
|
|
180
|
+
requestParameters: BlockNewDomainRequest,
|
|
181
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
182
|
+
): Promise<runtime.ApiResponse<void>>;
|
|
183
|
+
|
|
184
|
+
/**
|
|
185
|
+
* Blocks a new domain in order to avoid messages being sent to the same
|
|
186
|
+
* Add a new domain to the list of blocked domains
|
|
187
|
+
*/
|
|
188
|
+
blockNewDomain(requestParameters: BlockNewDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
189
|
+
|
|
190
|
+
/**
|
|
191
|
+
*
|
|
192
|
+
* @summary Create an email template
|
|
193
|
+
* @param {CreateSmtpTemplate} smtpTemplate values to update in transactional email template
|
|
194
|
+
* @param {*} [options] Override http request option.
|
|
195
|
+
* @throws {RequiredError}
|
|
196
|
+
* @memberof SMTPApiInterface
|
|
197
|
+
*/
|
|
198
|
+
createSmtpTemplateRaw(
|
|
199
|
+
requestParameters: CreateSmtpTemplateRequest,
|
|
200
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
201
|
+
): Promise<runtime.ApiResponse<CreateModel>>;
|
|
202
|
+
|
|
203
|
+
/**
|
|
204
|
+
* Create an email template
|
|
205
|
+
*/
|
|
206
|
+
createSmtpTemplate(
|
|
207
|
+
requestParameters: CreateSmtpTemplateRequest,
|
|
208
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
209
|
+
): Promise<CreateModel>;
|
|
210
|
+
|
|
211
|
+
/**
|
|
212
|
+
* Unblocks an existing domain from the list of blocked domains
|
|
213
|
+
* @summary Unblock an existing domain from the list of blocked domains
|
|
214
|
+
* @param {string} domain The name of the domain to be deleted
|
|
215
|
+
* @param {*} [options] Override http request option.
|
|
216
|
+
* @throws {RequiredError}
|
|
217
|
+
* @memberof SMTPApiInterface
|
|
218
|
+
*/
|
|
219
|
+
deleteBlockedDomainRaw(
|
|
220
|
+
requestParameters: DeleteBlockedDomainRequest,
|
|
221
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
222
|
+
): Promise<runtime.ApiResponse<void>>;
|
|
223
|
+
|
|
224
|
+
/**
|
|
225
|
+
* Unblocks an existing domain from the list of blocked domains
|
|
226
|
+
* Unblock an existing domain from the list of blocked domains
|
|
227
|
+
*/
|
|
228
|
+
deleteBlockedDomain(
|
|
229
|
+
requestParameters: DeleteBlockedDomainRequest,
|
|
230
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
231
|
+
): Promise<void>;
|
|
232
|
+
|
|
233
|
+
/**
|
|
234
|
+
* Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures)
|
|
235
|
+
* @summary Delete hardbounces
|
|
236
|
+
* @param {DeleteHardbounces} [deleteHardbounces] values to delete hardbounces
|
|
237
|
+
* @param {*} [options] Override http request option.
|
|
238
|
+
* @throws {RequiredError}
|
|
239
|
+
* @memberof SMTPApiInterface
|
|
240
|
+
*/
|
|
241
|
+
deleteHardbouncesRaw(
|
|
242
|
+
requestParameters: DeleteHardbouncesRequest,
|
|
243
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
244
|
+
): Promise<runtime.ApiResponse<void>>;
|
|
245
|
+
|
|
246
|
+
/**
|
|
247
|
+
* Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures)
|
|
248
|
+
* Delete hardbounces
|
|
249
|
+
*/
|
|
250
|
+
deleteHardbounces(requestParameters: DeleteHardbouncesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
251
|
+
|
|
252
|
+
/**
|
|
253
|
+
*
|
|
254
|
+
* @summary Delete an inactive email template
|
|
255
|
+
* @param {number} templateId id of the template
|
|
256
|
+
* @param {*} [options] Override http request option.
|
|
257
|
+
* @throws {RequiredError}
|
|
258
|
+
* @memberof SMTPApiInterface
|
|
259
|
+
*/
|
|
260
|
+
deleteSmtpTemplateRaw(
|
|
261
|
+
requestParameters: DeleteSmtpTemplateRequest,
|
|
262
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
263
|
+
): Promise<runtime.ApiResponse<void>>;
|
|
264
|
+
|
|
265
|
+
/**
|
|
266
|
+
* Delete an inactive email template
|
|
267
|
+
*/
|
|
268
|
+
deleteSmtpTemplate(
|
|
269
|
+
requestParameters: DeleteSmtpTemplateRequest,
|
|
270
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
271
|
+
): Promise<void>;
|
|
272
|
+
|
|
273
|
+
/**
|
|
274
|
+
*
|
|
275
|
+
* @summary Get your transactional email activity aggregated over a period of time
|
|
276
|
+
* @param {string} [startDate] Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
|
277
|
+
* @param {string} [endDate] Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
|
278
|
+
* @param {number} [days] Number of days in the past including today (positive integer). Not compatible with \'startDate\' and \'endDate\'
|
|
279
|
+
* @param {string} [tag] Tag of the emails
|
|
280
|
+
* @param {*} [options] Override http request option.
|
|
281
|
+
* @throws {RequiredError}
|
|
282
|
+
* @memberof SMTPApiInterface
|
|
283
|
+
*/
|
|
284
|
+
getAggregatedSmtpReportRaw(
|
|
285
|
+
requestParameters: GetAggregatedSmtpReportRequest,
|
|
286
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
287
|
+
): Promise<runtime.ApiResponse<GetAggregatedReport>>;
|
|
288
|
+
|
|
289
|
+
/**
|
|
290
|
+
* Get your transactional email activity aggregated over a period of time
|
|
291
|
+
*/
|
|
292
|
+
getAggregatedSmtpReport(
|
|
293
|
+
requestParameters: GetAggregatedSmtpReportRequest,
|
|
294
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
295
|
+
): Promise<GetAggregatedReport>;
|
|
296
|
+
|
|
297
|
+
/**
|
|
298
|
+
* Get the list of blocked domains
|
|
299
|
+
* @summary Get the list of blocked domains
|
|
300
|
+
* @param {*} [options] Override http request option.
|
|
301
|
+
* @throws {RequiredError}
|
|
302
|
+
* @memberof SMTPApiInterface
|
|
303
|
+
*/
|
|
304
|
+
getBlockedDomainsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetBlockedDomains>>;
|
|
305
|
+
|
|
306
|
+
/**
|
|
307
|
+
* Get the list of blocked domains
|
|
308
|
+
* Get the list of blocked domains
|
|
309
|
+
*/
|
|
310
|
+
getBlockedDomains(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetBlockedDomains>;
|
|
311
|
+
|
|
312
|
+
/**
|
|
313
|
+
*
|
|
314
|
+
* @summary Get all your transactional email activity (unaggregated events)
|
|
315
|
+
* @param {number} [limit] Number limitation for the result returned
|
|
316
|
+
* @param {number} [offset] Beginning point in the list to retrieve from.
|
|
317
|
+
* @param {string} [startDate] Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
|
318
|
+
* @param {string} [endDate] Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
|
319
|
+
* @param {number} [days] Number of days in the past including today (positive integer). Not compatible with \'startDate\' and \'endDate\'
|
|
320
|
+
* @param {string} [email] Filter the report for a specific email addresses
|
|
321
|
+
* @param {'bounces' | 'hardBounces' | 'softBounces' | 'delivered' | 'spam' | 'requests' | 'opened' | 'clicks' | 'invalid' | 'deferred' | 'blocked' | 'unsubscribed'} [event] Filter the report for a specific event type
|
|
322
|
+
* @param {string} [tags] Filter the report for tags (serialized and urlencoded array)
|
|
323
|
+
* @param {string} [messageId] Filter on a specific message id
|
|
324
|
+
* @param {number} [templateId] Filter on a specific template id
|
|
325
|
+
* @param {*} [options] Override http request option.
|
|
326
|
+
* @throws {RequiredError}
|
|
327
|
+
* @memberof SMTPApiInterface
|
|
328
|
+
*/
|
|
329
|
+
getEmailEventReportRaw(
|
|
330
|
+
requestParameters: GetEmailEventReportRequest,
|
|
331
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
332
|
+
): Promise<runtime.ApiResponse<GetEmailEventReport>>;
|
|
333
|
+
|
|
334
|
+
/**
|
|
335
|
+
* Get all your transactional email activity (unaggregated events)
|
|
336
|
+
*/
|
|
337
|
+
getEmailEventReport(
|
|
338
|
+
requestParameters: GetEmailEventReportRequest,
|
|
339
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
340
|
+
): Promise<GetEmailEventReport>;
|
|
341
|
+
|
|
342
|
+
/**
|
|
343
|
+
*
|
|
344
|
+
* @summary Get your transactional email activity aggregated per day
|
|
345
|
+
* @param {number} [limit] Number of documents returned per page
|
|
346
|
+
* @param {number} [offset] Index of the first document on the page
|
|
347
|
+
* @param {string} [startDate] Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
|
|
348
|
+
* @param {string} [endDate] Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
|
|
349
|
+
* @param {number} [days] Number of days in the past including today (positive integer). Not compatible with \'startDate\' and \'endDate\'
|
|
350
|
+
* @param {string} [tag] Tag of the emails
|
|
351
|
+
* @param {*} [options] Override http request option.
|
|
352
|
+
* @throws {RequiredError}
|
|
353
|
+
* @memberof SMTPApiInterface
|
|
354
|
+
*/
|
|
355
|
+
getSmtpReportRaw(
|
|
356
|
+
requestParameters: GetSmtpReportRequest,
|
|
357
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
358
|
+
): Promise<runtime.ApiResponse<GetReports>>;
|
|
359
|
+
|
|
360
|
+
/**
|
|
361
|
+
* Get your transactional email activity aggregated per day
|
|
362
|
+
*/
|
|
363
|
+
getSmtpReport(requestParameters: GetSmtpReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetReports>;
|
|
364
|
+
|
|
365
|
+
/**
|
|
366
|
+
*
|
|
367
|
+
* @summary Returns the template information
|
|
368
|
+
* @param {number} templateId id of the template
|
|
369
|
+
* @param {*} [options] Override http request option.
|
|
370
|
+
* @throws {RequiredError}
|
|
371
|
+
* @memberof SMTPApiInterface
|
|
372
|
+
*/
|
|
373
|
+
getSmtpTemplateRaw(
|
|
374
|
+
requestParameters: GetSmtpTemplateRequest,
|
|
375
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
376
|
+
): Promise<runtime.ApiResponse<GetSmtpTemplateOverview>>;
|
|
377
|
+
|
|
378
|
+
/**
|
|
379
|
+
* Returns the template information
|
|
380
|
+
*/
|
|
381
|
+
getSmtpTemplate(
|
|
382
|
+
requestParameters: GetSmtpTemplateRequest,
|
|
383
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
384
|
+
): Promise<GetSmtpTemplateOverview>;
|
|
385
|
+
|
|
386
|
+
/**
|
|
387
|
+
*
|
|
388
|
+
* @summary Get the list of email templates
|
|
389
|
+
* @param {boolean} [templateStatus] Filter on the status of the template. Active = true, inactive = false
|
|
390
|
+
* @param {number} [limit] Number of documents returned per page
|
|
391
|
+
* @param {number} [offset] Index of the first document in the page
|
|
392
|
+
* @param {*} [options] Override http request option.
|
|
393
|
+
* @throws {RequiredError}
|
|
394
|
+
* @memberof SMTPApiInterface
|
|
395
|
+
*/
|
|
396
|
+
getSmtpTemplatesRaw(
|
|
397
|
+
requestParameters: GetSmtpTemplatesRequest,
|
|
398
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
399
|
+
): Promise<runtime.ApiResponse<GetSmtpTemplates>>;
|
|
400
|
+
|
|
401
|
+
/**
|
|
402
|
+
* Get the list of email templates
|
|
403
|
+
*/
|
|
404
|
+
getSmtpTemplates(
|
|
405
|
+
requestParameters: GetSmtpTemplatesRequest,
|
|
406
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
407
|
+
): Promise<GetSmtpTemplates>;
|
|
408
|
+
|
|
409
|
+
/**
|
|
410
|
+
*
|
|
411
|
+
* @summary Get the list of blocked or unsubscribed transactional contacts
|
|
412
|
+
* @param {string} [startDate] Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts
|
|
413
|
+
* @param {string} [endDate] Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts
|
|
414
|
+
* @param {number} [limit] Number of documents returned per page
|
|
415
|
+
* @param {number} [offset] Index of the first document on the page
|
|
416
|
+
* @param {Array<string>} [senders] Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
|
|
417
|
+
* @param {*} [options] Override http request option.
|
|
418
|
+
* @throws {RequiredError}
|
|
419
|
+
* @memberof SMTPApiInterface
|
|
420
|
+
*/
|
|
421
|
+
getTransacBlockedContactsRaw(
|
|
422
|
+
requestParameters: GetTransacBlockedContactsRequest,
|
|
423
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
424
|
+
): Promise<runtime.ApiResponse<GetTransacBlockedContacts>>;
|
|
425
|
+
|
|
426
|
+
/**
|
|
427
|
+
* Get the list of blocked or unsubscribed transactional contacts
|
|
428
|
+
*/
|
|
429
|
+
getTransacBlockedContacts(
|
|
430
|
+
requestParameters: GetTransacBlockedContactsRequest,
|
|
431
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
432
|
+
): Promise<GetTransacBlockedContacts>;
|
|
433
|
+
|
|
434
|
+
/**
|
|
435
|
+
*
|
|
436
|
+
* @summary Get the personalized content of a sent transactional email
|
|
437
|
+
* @param {string} uuid Unique id of the transactional email that has been sent to a particular contact
|
|
438
|
+
* @param {*} [options] Override http request option.
|
|
439
|
+
* @throws {RequiredError}
|
|
440
|
+
* @memberof SMTPApiInterface
|
|
441
|
+
*/
|
|
442
|
+
getTransacEmailContentRaw(
|
|
443
|
+
requestParameters: GetTransacEmailContentRequest,
|
|
444
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
445
|
+
): Promise<runtime.ApiResponse<GetTransacEmailContent>>;
|
|
446
|
+
|
|
447
|
+
/**
|
|
448
|
+
* Get the personalized content of a sent transactional email
|
|
449
|
+
*/
|
|
450
|
+
getTransacEmailContent(
|
|
451
|
+
requestParameters: GetTransacEmailContentRequest,
|
|
452
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
453
|
+
): Promise<GetTransacEmailContent>;
|
|
454
|
+
|
|
455
|
+
/**
|
|
456
|
+
* 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.
|
|
457
|
+
* @summary Get the list of transactional emails on the basis of allowed filters
|
|
458
|
+
* @param {string} [email] Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
|
|
459
|
+
* @param {number} [templateId] Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
|
|
460
|
+
* @param {string} [messageId] Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
|
|
461
|
+
* @param {Date} [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.
|
|
462
|
+
* @param {Date} [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.
|
|
463
|
+
* @param {*} [options] Override http request option.
|
|
464
|
+
* @throws {RequiredError}
|
|
465
|
+
* @memberof SMTPApiInterface
|
|
466
|
+
*/
|
|
467
|
+
getTransacEmailsListRaw(
|
|
468
|
+
requestParameters: GetTransacEmailsListRequest,
|
|
469
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
470
|
+
): Promise<runtime.ApiResponse<GetTransacEmailsList>>;
|
|
471
|
+
|
|
472
|
+
/**
|
|
473
|
+
* 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.
|
|
474
|
+
* Get the list of transactional emails on the basis of allowed filters
|
|
475
|
+
*/
|
|
476
|
+
getTransacEmailsList(
|
|
477
|
+
requestParameters: GetTransacEmailsListRequest,
|
|
478
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
479
|
+
): Promise<GetTransacEmailsList>;
|
|
480
|
+
|
|
481
|
+
/**
|
|
482
|
+
* This endpoint is deprecated. Prefer v3/smtp/email instead.
|
|
483
|
+
* @summary Send a template
|
|
484
|
+
* @param {number} templateId Id of the template
|
|
485
|
+
* @param {SendEmail} sendEmail
|
|
486
|
+
* @param {*} [options] Override http request option.
|
|
487
|
+
* @deprecated
|
|
488
|
+
* @throws {RequiredError}
|
|
489
|
+
* @memberof SMTPApiInterface
|
|
490
|
+
*/
|
|
491
|
+
sendTemplateRaw(
|
|
492
|
+
requestParameters: SendTemplateRequest,
|
|
493
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
494
|
+
): Promise<runtime.ApiResponse<SendTemplateEmail>>;
|
|
495
|
+
|
|
496
|
+
/**
|
|
497
|
+
* This endpoint is deprecated. Prefer v3/smtp/email instead.
|
|
498
|
+
* Send a template
|
|
499
|
+
* @deprecated
|
|
500
|
+
*/
|
|
501
|
+
sendTemplate(
|
|
502
|
+
requestParameters: SendTemplateRequest,
|
|
503
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
504
|
+
): Promise<SendTemplateEmail>;
|
|
505
|
+
|
|
506
|
+
/**
|
|
507
|
+
*
|
|
508
|
+
* @summary Send a template to your test list
|
|
509
|
+
* @param {number} templateId Id of the template
|
|
510
|
+
* @param {SendTestEmail} sendTestEmail
|
|
511
|
+
* @param {*} [options] Override http request option.
|
|
512
|
+
* @throws {RequiredError}
|
|
513
|
+
* @memberof SMTPApiInterface
|
|
514
|
+
*/
|
|
515
|
+
sendTestTemplateRaw(
|
|
516
|
+
requestParameters: SendTestTemplateRequest,
|
|
517
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
518
|
+
): Promise<runtime.ApiResponse<void>>;
|
|
519
|
+
|
|
520
|
+
/**
|
|
521
|
+
* Send a template to your test list
|
|
522
|
+
*/
|
|
523
|
+
sendTestTemplate(requestParameters: SendTestTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
524
|
+
|
|
525
|
+
/**
|
|
526
|
+
*
|
|
527
|
+
* @summary Send a transactional email
|
|
528
|
+
* @param {SendSmtpEmail} sendSmtpEmail Values to send a transactional email
|
|
529
|
+
* @param {*} [options] Override http request option.
|
|
530
|
+
* @throws {RequiredError}
|
|
531
|
+
* @memberof SMTPApiInterface
|
|
532
|
+
*/
|
|
533
|
+
sendTransacEmailRaw(
|
|
534
|
+
requestParameters: SendTransacEmailRequest,
|
|
535
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
536
|
+
): Promise<runtime.ApiResponse<CreateSmtpEmail>>;
|
|
537
|
+
|
|
538
|
+
/**
|
|
539
|
+
* Send a transactional email
|
|
540
|
+
*/
|
|
541
|
+
sendTransacEmail(
|
|
542
|
+
requestParameters: SendTransacEmailRequest,
|
|
543
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
544
|
+
): Promise<CreateSmtpEmail>;
|
|
545
|
+
|
|
546
|
+
/**
|
|
547
|
+
*
|
|
548
|
+
* @summary Unblock or resubscribe a transactional contact
|
|
549
|
+
* @param {string} email contact email (urlencoded) to unblock.
|
|
550
|
+
* @param {*} [options] Override http request option.
|
|
551
|
+
* @throws {RequiredError}
|
|
552
|
+
* @memberof SMTPApiInterface
|
|
553
|
+
*/
|
|
554
|
+
smtpBlockedContactsEmailDeleteRaw(
|
|
555
|
+
requestParameters: SmtpBlockedContactsEmailDeleteRequest,
|
|
556
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
557
|
+
): Promise<runtime.ApiResponse<void>>;
|
|
558
|
+
|
|
559
|
+
/**
|
|
560
|
+
* Unblock or resubscribe a transactional contact
|
|
561
|
+
*/
|
|
562
|
+
smtpBlockedContactsEmailDelete(
|
|
563
|
+
requestParameters: SmtpBlockedContactsEmailDeleteRequest,
|
|
564
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
565
|
+
): Promise<void>;
|
|
566
|
+
|
|
567
|
+
/**
|
|
568
|
+
*
|
|
569
|
+
* @summary Delete an SMTP transactional log
|
|
570
|
+
* @param {string} messageId MessageId of the transactional log to delete
|
|
571
|
+
* @param {*} [options] Override http request option.
|
|
572
|
+
* @throws {RequiredError}
|
|
573
|
+
* @memberof SMTPApiInterface
|
|
574
|
+
*/
|
|
575
|
+
smtpLogMessageIdDeleteRaw(
|
|
576
|
+
requestParameters: SmtpLogMessageIdDeleteRequest,
|
|
577
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
578
|
+
): Promise<runtime.ApiResponse<void>>;
|
|
579
|
+
|
|
580
|
+
/**
|
|
581
|
+
* Delete an SMTP transactional log
|
|
582
|
+
*/
|
|
583
|
+
smtpLogMessageIdDelete(
|
|
584
|
+
requestParameters: SmtpLogMessageIdDeleteRequest,
|
|
585
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
586
|
+
): Promise<void>;
|
|
587
|
+
|
|
588
|
+
/**
|
|
589
|
+
*
|
|
590
|
+
* @summary Update an email template
|
|
591
|
+
* @param {number} templateId id of the template
|
|
592
|
+
* @param {UpdateSmtpTemplate} smtpTemplate values to update in transactional email template
|
|
593
|
+
* @param {*} [options] Override http request option.
|
|
594
|
+
* @throws {RequiredError}
|
|
595
|
+
* @memberof SMTPApiInterface
|
|
596
|
+
*/
|
|
597
|
+
updateSmtpTemplateRaw(
|
|
598
|
+
requestParameters: UpdateSmtpTemplateRequest,
|
|
599
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
600
|
+
): Promise<runtime.ApiResponse<void>>;
|
|
601
|
+
|
|
602
|
+
/**
|
|
603
|
+
* Update an email template
|
|
604
|
+
*/
|
|
605
|
+
updateSmtpTemplate(
|
|
606
|
+
requestParameters: UpdateSmtpTemplateRequest,
|
|
607
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
608
|
+
): Promise<void>;
|
|
609
|
+
}
|
|
610
|
+
|
|
611
|
+
/**
|
|
612
|
+
*
|
|
613
|
+
*/
|
|
614
|
+
export class SMTPApi extends runtime.BaseAPI implements SMTPApiInterface {
|
|
615
|
+
/**
|
|
616
|
+
* Blocks a new domain in order to avoid messages being sent to the same
|
|
617
|
+
* Add a new domain to the list of blocked domains
|
|
618
|
+
*/
|
|
619
|
+
async blockNewDomainRaw(
|
|
620
|
+
requestParameters: BlockNewDomainRequest,
|
|
621
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
622
|
+
): Promise<runtime.ApiResponse<void>> {
|
|
623
|
+
if (requestParameters.blockDomain === null || requestParameters.blockDomain === undefined) {
|
|
624
|
+
throw new runtime.RequiredError(
|
|
625
|
+
'blockDomain',
|
|
626
|
+
'Required parameter requestParameters.blockDomain was null or undefined when calling blockNewDomain.',
|
|
627
|
+
);
|
|
628
|
+
}
|
|
629
|
+
|
|
630
|
+
const queryParameters: any = {};
|
|
631
|
+
|
|
632
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
633
|
+
|
|
634
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
635
|
+
|
|
636
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
637
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
638
|
+
}
|
|
639
|
+
|
|
640
|
+
const response = await this.request(
|
|
641
|
+
{
|
|
642
|
+
path: `/smtp/blockedDomains`,
|
|
643
|
+
method: 'POST',
|
|
644
|
+
headers: headerParameters,
|
|
645
|
+
query: queryParameters,
|
|
646
|
+
body: BlockDomainToJSON(requestParameters.blockDomain),
|
|
647
|
+
},
|
|
648
|
+
initOverrides,
|
|
649
|
+
);
|
|
650
|
+
|
|
651
|
+
return new runtime.VoidApiResponse(response);
|
|
652
|
+
}
|
|
653
|
+
|
|
654
|
+
/**
|
|
655
|
+
* Blocks a new domain in order to avoid messages being sent to the same
|
|
656
|
+
* Add a new domain to the list of blocked domains
|
|
657
|
+
*/
|
|
658
|
+
async blockNewDomain(
|
|
659
|
+
requestParameters: BlockNewDomainRequest,
|
|
660
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
661
|
+
): Promise<void> {
|
|
662
|
+
await this.blockNewDomainRaw(requestParameters, initOverrides);
|
|
663
|
+
}
|
|
664
|
+
|
|
665
|
+
/**
|
|
666
|
+
* Create an email template
|
|
667
|
+
*/
|
|
668
|
+
async createSmtpTemplateRaw(
|
|
669
|
+
requestParameters: CreateSmtpTemplateRequest,
|
|
670
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
671
|
+
): Promise<runtime.ApiResponse<CreateModel>> {
|
|
672
|
+
if (requestParameters.smtpTemplate === null || requestParameters.smtpTemplate === undefined) {
|
|
673
|
+
throw new runtime.RequiredError(
|
|
674
|
+
'smtpTemplate',
|
|
675
|
+
'Required parameter requestParameters.smtpTemplate was null or undefined when calling createSmtpTemplate.',
|
|
676
|
+
);
|
|
677
|
+
}
|
|
678
|
+
|
|
679
|
+
const queryParameters: any = {};
|
|
680
|
+
|
|
681
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
682
|
+
|
|
683
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
684
|
+
|
|
685
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
686
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
687
|
+
}
|
|
688
|
+
|
|
689
|
+
const response = await this.request(
|
|
690
|
+
{
|
|
691
|
+
path: `/smtp/templates`,
|
|
692
|
+
method: 'POST',
|
|
693
|
+
headers: headerParameters,
|
|
694
|
+
query: queryParameters,
|
|
695
|
+
body: CreateSmtpTemplateToJSON(requestParameters.smtpTemplate),
|
|
696
|
+
},
|
|
697
|
+
initOverrides,
|
|
698
|
+
);
|
|
699
|
+
|
|
700
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CreateModelFromJSON(jsonValue));
|
|
701
|
+
}
|
|
702
|
+
|
|
703
|
+
/**
|
|
704
|
+
* Create an email template
|
|
705
|
+
*/
|
|
706
|
+
async createSmtpTemplate(
|
|
707
|
+
requestParameters: CreateSmtpTemplateRequest,
|
|
708
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
709
|
+
): Promise<CreateModel> {
|
|
710
|
+
const response = await this.createSmtpTemplateRaw(requestParameters, initOverrides);
|
|
711
|
+
return await response.value();
|
|
712
|
+
}
|
|
713
|
+
|
|
714
|
+
/**
|
|
715
|
+
* Unblocks an existing domain from the list of blocked domains
|
|
716
|
+
* Unblock an existing domain from the list of blocked domains
|
|
717
|
+
*/
|
|
718
|
+
async deleteBlockedDomainRaw(
|
|
719
|
+
requestParameters: DeleteBlockedDomainRequest,
|
|
720
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
721
|
+
): Promise<runtime.ApiResponse<void>> {
|
|
722
|
+
if (requestParameters.domain === null || requestParameters.domain === undefined) {
|
|
723
|
+
throw new runtime.RequiredError(
|
|
724
|
+
'domain',
|
|
725
|
+
'Required parameter requestParameters.domain was null or undefined when calling deleteBlockedDomain.',
|
|
726
|
+
);
|
|
727
|
+
}
|
|
728
|
+
|
|
729
|
+
const queryParameters: any = {};
|
|
730
|
+
|
|
731
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
732
|
+
|
|
733
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
734
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
735
|
+
}
|
|
736
|
+
|
|
737
|
+
const response = await this.request(
|
|
738
|
+
{
|
|
739
|
+
path: `/smtp/blockedDomains/{domain}`.replace(`{${'domain'}}`, encodeURIComponent(String(requestParameters.domain))),
|
|
740
|
+
method: 'DELETE',
|
|
741
|
+
headers: headerParameters,
|
|
742
|
+
query: queryParameters,
|
|
743
|
+
},
|
|
744
|
+
initOverrides,
|
|
745
|
+
);
|
|
746
|
+
|
|
747
|
+
return new runtime.VoidApiResponse(response);
|
|
748
|
+
}
|
|
749
|
+
|
|
750
|
+
/**
|
|
751
|
+
* Unblocks an existing domain from the list of blocked domains
|
|
752
|
+
* Unblock an existing domain from the list of blocked domains
|
|
753
|
+
*/
|
|
754
|
+
async deleteBlockedDomain(
|
|
755
|
+
requestParameters: DeleteBlockedDomainRequest,
|
|
756
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
757
|
+
): Promise<void> {
|
|
758
|
+
await this.deleteBlockedDomainRaw(requestParameters, initOverrides);
|
|
759
|
+
}
|
|
760
|
+
|
|
761
|
+
/**
|
|
762
|
+
* Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures)
|
|
763
|
+
* Delete hardbounces
|
|
764
|
+
*/
|
|
765
|
+
async deleteHardbouncesRaw(
|
|
766
|
+
requestParameters: DeleteHardbouncesRequest,
|
|
767
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
768
|
+
): Promise<runtime.ApiResponse<void>> {
|
|
769
|
+
const queryParameters: any = {};
|
|
770
|
+
|
|
771
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
772
|
+
|
|
773
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
774
|
+
|
|
775
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
776
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
777
|
+
}
|
|
778
|
+
|
|
779
|
+
const response = await this.request(
|
|
780
|
+
{
|
|
781
|
+
path: `/smtp/deleteHardbounces`,
|
|
782
|
+
method: 'POST',
|
|
783
|
+
headers: headerParameters,
|
|
784
|
+
query: queryParameters,
|
|
785
|
+
body: DeleteHardbouncesToJSON(requestParameters.deleteHardbounces),
|
|
786
|
+
},
|
|
787
|
+
initOverrides,
|
|
788
|
+
);
|
|
789
|
+
|
|
790
|
+
return new runtime.VoidApiResponse(response);
|
|
791
|
+
}
|
|
792
|
+
|
|
793
|
+
/**
|
|
794
|
+
* Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures)
|
|
795
|
+
* Delete hardbounces
|
|
796
|
+
*/
|
|
797
|
+
async deleteHardbounces(
|
|
798
|
+
requestParameters: DeleteHardbouncesRequest = {},
|
|
799
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
800
|
+
): Promise<void> {
|
|
801
|
+
await this.deleteHardbouncesRaw(requestParameters, initOverrides);
|
|
802
|
+
}
|
|
803
|
+
|
|
804
|
+
/**
|
|
805
|
+
* Delete an inactive email template
|
|
806
|
+
*/
|
|
807
|
+
async deleteSmtpTemplateRaw(
|
|
808
|
+
requestParameters: DeleteSmtpTemplateRequest,
|
|
809
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
810
|
+
): Promise<runtime.ApiResponse<void>> {
|
|
811
|
+
if (requestParameters.templateId === null || requestParameters.templateId === undefined) {
|
|
812
|
+
throw new runtime.RequiredError(
|
|
813
|
+
'templateId',
|
|
814
|
+
'Required parameter requestParameters.templateId was null or undefined when calling deleteSmtpTemplate.',
|
|
815
|
+
);
|
|
816
|
+
}
|
|
817
|
+
|
|
818
|
+
const queryParameters: any = {};
|
|
819
|
+
|
|
820
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
821
|
+
|
|
822
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
823
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
824
|
+
}
|
|
825
|
+
|
|
826
|
+
const response = await this.request(
|
|
827
|
+
{
|
|
828
|
+
path: `/smtp/templates/{templateId}`.replace(`{${'templateId'}}`, encodeURIComponent(String(requestParameters.templateId))),
|
|
829
|
+
method: 'DELETE',
|
|
830
|
+
headers: headerParameters,
|
|
831
|
+
query: queryParameters,
|
|
832
|
+
},
|
|
833
|
+
initOverrides,
|
|
834
|
+
);
|
|
835
|
+
|
|
836
|
+
return new runtime.VoidApiResponse(response);
|
|
837
|
+
}
|
|
838
|
+
|
|
839
|
+
/**
|
|
840
|
+
* Delete an inactive email template
|
|
841
|
+
*/
|
|
842
|
+
async deleteSmtpTemplate(
|
|
843
|
+
requestParameters: DeleteSmtpTemplateRequest,
|
|
844
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
845
|
+
): Promise<void> {
|
|
846
|
+
await this.deleteSmtpTemplateRaw(requestParameters, initOverrides);
|
|
847
|
+
}
|
|
848
|
+
|
|
849
|
+
/**
|
|
850
|
+
* Get your transactional email activity aggregated over a period of time
|
|
851
|
+
*/
|
|
852
|
+
async getAggregatedSmtpReportRaw(
|
|
853
|
+
requestParameters: GetAggregatedSmtpReportRequest,
|
|
854
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
855
|
+
): Promise<runtime.ApiResponse<GetAggregatedReport>> {
|
|
856
|
+
const queryParameters: any = {};
|
|
857
|
+
|
|
858
|
+
if (requestParameters.startDate !== undefined) {
|
|
859
|
+
queryParameters['startDate'] = requestParameters.startDate;
|
|
860
|
+
}
|
|
861
|
+
|
|
862
|
+
if (requestParameters.endDate !== undefined) {
|
|
863
|
+
queryParameters['endDate'] = requestParameters.endDate;
|
|
864
|
+
}
|
|
865
|
+
|
|
866
|
+
if (requestParameters.days !== undefined) {
|
|
867
|
+
queryParameters['days'] = requestParameters.days;
|
|
868
|
+
}
|
|
869
|
+
|
|
870
|
+
if (requestParameters.tag !== undefined) {
|
|
871
|
+
queryParameters['tag'] = requestParameters.tag;
|
|
872
|
+
}
|
|
873
|
+
|
|
874
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
875
|
+
|
|
876
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
877
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
878
|
+
}
|
|
879
|
+
|
|
880
|
+
const response = await this.request(
|
|
881
|
+
{
|
|
882
|
+
path: `/smtp/statistics/aggregatedReport`,
|
|
883
|
+
method: 'GET',
|
|
884
|
+
headers: headerParameters,
|
|
885
|
+
query: queryParameters,
|
|
886
|
+
},
|
|
887
|
+
initOverrides,
|
|
888
|
+
);
|
|
889
|
+
|
|
890
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetAggregatedReportFromJSON(jsonValue));
|
|
891
|
+
}
|
|
892
|
+
|
|
893
|
+
/**
|
|
894
|
+
* Get your transactional email activity aggregated over a period of time
|
|
895
|
+
*/
|
|
896
|
+
async getAggregatedSmtpReport(
|
|
897
|
+
requestParameters: GetAggregatedSmtpReportRequest = {},
|
|
898
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
899
|
+
): Promise<GetAggregatedReport> {
|
|
900
|
+
const response = await this.getAggregatedSmtpReportRaw(requestParameters, initOverrides);
|
|
901
|
+
return await response.value();
|
|
902
|
+
}
|
|
903
|
+
|
|
904
|
+
/**
|
|
905
|
+
* Get the list of blocked domains
|
|
906
|
+
* Get the list of blocked domains
|
|
907
|
+
*/
|
|
908
|
+
async getBlockedDomainsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetBlockedDomains>> {
|
|
909
|
+
const queryParameters: any = {};
|
|
910
|
+
|
|
911
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
912
|
+
|
|
913
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
914
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
915
|
+
}
|
|
916
|
+
|
|
917
|
+
const response = await this.request(
|
|
918
|
+
{
|
|
919
|
+
path: `/smtp/blockedDomains`,
|
|
920
|
+
method: 'GET',
|
|
921
|
+
headers: headerParameters,
|
|
922
|
+
query: queryParameters,
|
|
923
|
+
},
|
|
924
|
+
initOverrides,
|
|
925
|
+
);
|
|
926
|
+
|
|
927
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetBlockedDomainsFromJSON(jsonValue));
|
|
928
|
+
}
|
|
929
|
+
|
|
930
|
+
/**
|
|
931
|
+
* Get the list of blocked domains
|
|
932
|
+
* Get the list of blocked domains
|
|
933
|
+
*/
|
|
934
|
+
async getBlockedDomains(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetBlockedDomains> {
|
|
935
|
+
const response = await this.getBlockedDomainsRaw(initOverrides);
|
|
936
|
+
return await response.value();
|
|
937
|
+
}
|
|
938
|
+
|
|
939
|
+
/**
|
|
940
|
+
* Get all your transactional email activity (unaggregated events)
|
|
941
|
+
*/
|
|
942
|
+
async getEmailEventReportRaw(
|
|
943
|
+
requestParameters: GetEmailEventReportRequest,
|
|
944
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
945
|
+
): Promise<runtime.ApiResponse<GetEmailEventReport>> {
|
|
946
|
+
const queryParameters: any = {};
|
|
947
|
+
|
|
948
|
+
if (requestParameters.limit !== undefined) {
|
|
949
|
+
queryParameters['limit'] = requestParameters.limit;
|
|
950
|
+
}
|
|
951
|
+
|
|
952
|
+
if (requestParameters.offset !== undefined) {
|
|
953
|
+
queryParameters['offset'] = requestParameters.offset;
|
|
954
|
+
}
|
|
955
|
+
|
|
956
|
+
if (requestParameters.startDate !== undefined) {
|
|
957
|
+
queryParameters['startDate'] = requestParameters.startDate;
|
|
958
|
+
}
|
|
959
|
+
|
|
960
|
+
if (requestParameters.endDate !== undefined) {
|
|
961
|
+
queryParameters['endDate'] = requestParameters.endDate;
|
|
962
|
+
}
|
|
963
|
+
|
|
964
|
+
if (requestParameters.days !== undefined) {
|
|
965
|
+
queryParameters['days'] = requestParameters.days;
|
|
966
|
+
}
|
|
967
|
+
|
|
968
|
+
if (requestParameters.email !== undefined) {
|
|
969
|
+
queryParameters['email'] = requestParameters.email;
|
|
970
|
+
}
|
|
971
|
+
|
|
972
|
+
if (requestParameters.event !== undefined) {
|
|
973
|
+
queryParameters['event'] = requestParameters.event;
|
|
974
|
+
}
|
|
975
|
+
|
|
976
|
+
if (requestParameters.tags !== undefined) {
|
|
977
|
+
queryParameters['tags'] = requestParameters.tags;
|
|
978
|
+
}
|
|
979
|
+
|
|
980
|
+
if (requestParameters.messageId !== undefined) {
|
|
981
|
+
queryParameters['messageId'] = requestParameters.messageId;
|
|
982
|
+
}
|
|
983
|
+
|
|
984
|
+
if (requestParameters.templateId !== undefined) {
|
|
985
|
+
queryParameters['templateId'] = requestParameters.templateId;
|
|
986
|
+
}
|
|
987
|
+
|
|
988
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
989
|
+
|
|
990
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
991
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
992
|
+
}
|
|
993
|
+
|
|
994
|
+
const response = await this.request(
|
|
995
|
+
{
|
|
996
|
+
path: `/smtp/statistics/events`,
|
|
997
|
+
method: 'GET',
|
|
998
|
+
headers: headerParameters,
|
|
999
|
+
query: queryParameters,
|
|
1000
|
+
},
|
|
1001
|
+
initOverrides,
|
|
1002
|
+
);
|
|
1003
|
+
|
|
1004
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetEmailEventReportFromJSON(jsonValue));
|
|
1005
|
+
}
|
|
1006
|
+
|
|
1007
|
+
/**
|
|
1008
|
+
* Get all your transactional email activity (unaggregated events)
|
|
1009
|
+
*/
|
|
1010
|
+
async getEmailEventReport(
|
|
1011
|
+
requestParameters: GetEmailEventReportRequest = {},
|
|
1012
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1013
|
+
): Promise<GetEmailEventReport> {
|
|
1014
|
+
const response = await this.getEmailEventReportRaw(requestParameters, initOverrides);
|
|
1015
|
+
return await response.value();
|
|
1016
|
+
}
|
|
1017
|
+
|
|
1018
|
+
/**
|
|
1019
|
+
* Get your transactional email activity aggregated per day
|
|
1020
|
+
*/
|
|
1021
|
+
async getSmtpReportRaw(
|
|
1022
|
+
requestParameters: GetSmtpReportRequest,
|
|
1023
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1024
|
+
): Promise<runtime.ApiResponse<GetReports>> {
|
|
1025
|
+
const queryParameters: any = {};
|
|
1026
|
+
|
|
1027
|
+
if (requestParameters.limit !== undefined) {
|
|
1028
|
+
queryParameters['limit'] = requestParameters.limit;
|
|
1029
|
+
}
|
|
1030
|
+
|
|
1031
|
+
if (requestParameters.offset !== undefined) {
|
|
1032
|
+
queryParameters['offset'] = requestParameters.offset;
|
|
1033
|
+
}
|
|
1034
|
+
|
|
1035
|
+
if (requestParameters.startDate !== undefined) {
|
|
1036
|
+
queryParameters['startDate'] = requestParameters.startDate;
|
|
1037
|
+
}
|
|
1038
|
+
|
|
1039
|
+
if (requestParameters.endDate !== undefined) {
|
|
1040
|
+
queryParameters['endDate'] = requestParameters.endDate;
|
|
1041
|
+
}
|
|
1042
|
+
|
|
1043
|
+
if (requestParameters.days !== undefined) {
|
|
1044
|
+
queryParameters['days'] = requestParameters.days;
|
|
1045
|
+
}
|
|
1046
|
+
|
|
1047
|
+
if (requestParameters.tag !== undefined) {
|
|
1048
|
+
queryParameters['tag'] = requestParameters.tag;
|
|
1049
|
+
}
|
|
1050
|
+
|
|
1051
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1052
|
+
|
|
1053
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1054
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1055
|
+
}
|
|
1056
|
+
|
|
1057
|
+
const response = await this.request(
|
|
1058
|
+
{
|
|
1059
|
+
path: `/smtp/statistics/reports`,
|
|
1060
|
+
method: 'GET',
|
|
1061
|
+
headers: headerParameters,
|
|
1062
|
+
query: queryParameters,
|
|
1063
|
+
},
|
|
1064
|
+
initOverrides,
|
|
1065
|
+
);
|
|
1066
|
+
|
|
1067
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetReportsFromJSON(jsonValue));
|
|
1068
|
+
}
|
|
1069
|
+
|
|
1070
|
+
/**
|
|
1071
|
+
* Get your transactional email activity aggregated per day
|
|
1072
|
+
*/
|
|
1073
|
+
async getSmtpReport(
|
|
1074
|
+
requestParameters: GetSmtpReportRequest = {},
|
|
1075
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1076
|
+
): Promise<GetReports> {
|
|
1077
|
+
const response = await this.getSmtpReportRaw(requestParameters, initOverrides);
|
|
1078
|
+
return await response.value();
|
|
1079
|
+
}
|
|
1080
|
+
|
|
1081
|
+
/**
|
|
1082
|
+
* Returns the template information
|
|
1083
|
+
*/
|
|
1084
|
+
async getSmtpTemplateRaw(
|
|
1085
|
+
requestParameters: GetSmtpTemplateRequest,
|
|
1086
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1087
|
+
): Promise<runtime.ApiResponse<GetSmtpTemplateOverview>> {
|
|
1088
|
+
if (requestParameters.templateId === null || requestParameters.templateId === undefined) {
|
|
1089
|
+
throw new runtime.RequiredError(
|
|
1090
|
+
'templateId',
|
|
1091
|
+
'Required parameter requestParameters.templateId was null or undefined when calling getSmtpTemplate.',
|
|
1092
|
+
);
|
|
1093
|
+
}
|
|
1094
|
+
|
|
1095
|
+
const queryParameters: any = {};
|
|
1096
|
+
|
|
1097
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1098
|
+
|
|
1099
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1100
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1101
|
+
}
|
|
1102
|
+
|
|
1103
|
+
const response = await this.request(
|
|
1104
|
+
{
|
|
1105
|
+
path: `/smtp/templates/{templateId}`.replace(`{${'templateId'}}`, encodeURIComponent(String(requestParameters.templateId))),
|
|
1106
|
+
method: 'GET',
|
|
1107
|
+
headers: headerParameters,
|
|
1108
|
+
query: queryParameters,
|
|
1109
|
+
},
|
|
1110
|
+
initOverrides,
|
|
1111
|
+
);
|
|
1112
|
+
|
|
1113
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetSmtpTemplateOverviewFromJSON(jsonValue));
|
|
1114
|
+
}
|
|
1115
|
+
|
|
1116
|
+
/**
|
|
1117
|
+
* Returns the template information
|
|
1118
|
+
*/
|
|
1119
|
+
async getSmtpTemplate(
|
|
1120
|
+
requestParameters: GetSmtpTemplateRequest,
|
|
1121
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1122
|
+
): Promise<GetSmtpTemplateOverview> {
|
|
1123
|
+
const response = await this.getSmtpTemplateRaw(requestParameters, initOverrides);
|
|
1124
|
+
return await response.value();
|
|
1125
|
+
}
|
|
1126
|
+
|
|
1127
|
+
/**
|
|
1128
|
+
* Get the list of email templates
|
|
1129
|
+
*/
|
|
1130
|
+
async getSmtpTemplatesRaw(
|
|
1131
|
+
requestParameters: GetSmtpTemplatesRequest,
|
|
1132
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1133
|
+
): Promise<runtime.ApiResponse<GetSmtpTemplates>> {
|
|
1134
|
+
const queryParameters: any = {};
|
|
1135
|
+
|
|
1136
|
+
if (requestParameters.templateStatus !== undefined) {
|
|
1137
|
+
queryParameters['templateStatus'] = requestParameters.templateStatus;
|
|
1138
|
+
}
|
|
1139
|
+
|
|
1140
|
+
if (requestParameters.limit !== undefined) {
|
|
1141
|
+
queryParameters['limit'] = requestParameters.limit;
|
|
1142
|
+
}
|
|
1143
|
+
|
|
1144
|
+
if (requestParameters.offset !== undefined) {
|
|
1145
|
+
queryParameters['offset'] = requestParameters.offset;
|
|
1146
|
+
}
|
|
1147
|
+
|
|
1148
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1149
|
+
|
|
1150
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1151
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1152
|
+
}
|
|
1153
|
+
|
|
1154
|
+
const response = await this.request(
|
|
1155
|
+
{
|
|
1156
|
+
path: `/smtp/templates`,
|
|
1157
|
+
method: 'GET',
|
|
1158
|
+
headers: headerParameters,
|
|
1159
|
+
query: queryParameters,
|
|
1160
|
+
},
|
|
1161
|
+
initOverrides,
|
|
1162
|
+
);
|
|
1163
|
+
|
|
1164
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetSmtpTemplatesFromJSON(jsonValue));
|
|
1165
|
+
}
|
|
1166
|
+
|
|
1167
|
+
/**
|
|
1168
|
+
* Get the list of email templates
|
|
1169
|
+
*/
|
|
1170
|
+
async getSmtpTemplates(
|
|
1171
|
+
requestParameters: GetSmtpTemplatesRequest = {},
|
|
1172
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1173
|
+
): Promise<GetSmtpTemplates> {
|
|
1174
|
+
const response = await this.getSmtpTemplatesRaw(requestParameters, initOverrides);
|
|
1175
|
+
return await response.value();
|
|
1176
|
+
}
|
|
1177
|
+
|
|
1178
|
+
/**
|
|
1179
|
+
* Get the list of blocked or unsubscribed transactional contacts
|
|
1180
|
+
*/
|
|
1181
|
+
async getTransacBlockedContactsRaw(
|
|
1182
|
+
requestParameters: GetTransacBlockedContactsRequest,
|
|
1183
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1184
|
+
): Promise<runtime.ApiResponse<GetTransacBlockedContacts>> {
|
|
1185
|
+
const queryParameters: any = {};
|
|
1186
|
+
|
|
1187
|
+
if (requestParameters.startDate !== undefined) {
|
|
1188
|
+
queryParameters['startDate'] = requestParameters.startDate;
|
|
1189
|
+
}
|
|
1190
|
+
|
|
1191
|
+
if (requestParameters.endDate !== undefined) {
|
|
1192
|
+
queryParameters['endDate'] = requestParameters.endDate;
|
|
1193
|
+
}
|
|
1194
|
+
|
|
1195
|
+
if (requestParameters.limit !== undefined) {
|
|
1196
|
+
queryParameters['limit'] = requestParameters.limit;
|
|
1197
|
+
}
|
|
1198
|
+
|
|
1199
|
+
if (requestParameters.offset !== undefined) {
|
|
1200
|
+
queryParameters['offset'] = requestParameters.offset;
|
|
1201
|
+
}
|
|
1202
|
+
|
|
1203
|
+
if (requestParameters.senders) {
|
|
1204
|
+
queryParameters['senders'] = requestParameters.senders.join(runtime.COLLECTION_FORMATS['csv']);
|
|
1205
|
+
}
|
|
1206
|
+
|
|
1207
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1208
|
+
|
|
1209
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1210
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1211
|
+
}
|
|
1212
|
+
|
|
1213
|
+
const response = await this.request(
|
|
1214
|
+
{
|
|
1215
|
+
path: `/smtp/blockedContacts`,
|
|
1216
|
+
method: 'GET',
|
|
1217
|
+
headers: headerParameters,
|
|
1218
|
+
query: queryParameters,
|
|
1219
|
+
},
|
|
1220
|
+
initOverrides,
|
|
1221
|
+
);
|
|
1222
|
+
|
|
1223
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetTransacBlockedContactsFromJSON(jsonValue));
|
|
1224
|
+
}
|
|
1225
|
+
|
|
1226
|
+
/**
|
|
1227
|
+
* Get the list of blocked or unsubscribed transactional contacts
|
|
1228
|
+
*/
|
|
1229
|
+
async getTransacBlockedContacts(
|
|
1230
|
+
requestParameters: GetTransacBlockedContactsRequest = {},
|
|
1231
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1232
|
+
): Promise<GetTransacBlockedContacts> {
|
|
1233
|
+
const response = await this.getTransacBlockedContactsRaw(requestParameters, initOverrides);
|
|
1234
|
+
return await response.value();
|
|
1235
|
+
}
|
|
1236
|
+
|
|
1237
|
+
/**
|
|
1238
|
+
* Get the personalized content of a sent transactional email
|
|
1239
|
+
*/
|
|
1240
|
+
async getTransacEmailContentRaw(
|
|
1241
|
+
requestParameters: GetTransacEmailContentRequest,
|
|
1242
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1243
|
+
): Promise<runtime.ApiResponse<GetTransacEmailContent>> {
|
|
1244
|
+
if (requestParameters.uuid === null || requestParameters.uuid === undefined) {
|
|
1245
|
+
throw new runtime.RequiredError(
|
|
1246
|
+
'uuid',
|
|
1247
|
+
'Required parameter requestParameters.uuid was null or undefined when calling getTransacEmailContent.',
|
|
1248
|
+
);
|
|
1249
|
+
}
|
|
1250
|
+
|
|
1251
|
+
const queryParameters: any = {};
|
|
1252
|
+
|
|
1253
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1254
|
+
|
|
1255
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1256
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1257
|
+
}
|
|
1258
|
+
|
|
1259
|
+
const response = await this.request(
|
|
1260
|
+
{
|
|
1261
|
+
path: `/smtp/emails/{uuid}`.replace(`{${'uuid'}}`, encodeURIComponent(String(requestParameters.uuid))),
|
|
1262
|
+
method: 'GET',
|
|
1263
|
+
headers: headerParameters,
|
|
1264
|
+
query: queryParameters,
|
|
1265
|
+
},
|
|
1266
|
+
initOverrides,
|
|
1267
|
+
);
|
|
1268
|
+
|
|
1269
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetTransacEmailContentFromJSON(jsonValue));
|
|
1270
|
+
}
|
|
1271
|
+
|
|
1272
|
+
/**
|
|
1273
|
+
* Get the personalized content of a sent transactional email
|
|
1274
|
+
*/
|
|
1275
|
+
async getTransacEmailContent(
|
|
1276
|
+
requestParameters: GetTransacEmailContentRequest,
|
|
1277
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1278
|
+
): Promise<GetTransacEmailContent> {
|
|
1279
|
+
const response = await this.getTransacEmailContentRaw(requestParameters, initOverrides);
|
|
1280
|
+
return await response.value();
|
|
1281
|
+
}
|
|
1282
|
+
|
|
1283
|
+
/**
|
|
1284
|
+
* 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.
|
|
1285
|
+
* Get the list of transactional emails on the basis of allowed filters
|
|
1286
|
+
*/
|
|
1287
|
+
async getTransacEmailsListRaw(
|
|
1288
|
+
requestParameters: GetTransacEmailsListRequest,
|
|
1289
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1290
|
+
): Promise<runtime.ApiResponse<GetTransacEmailsList>> {
|
|
1291
|
+
const queryParameters: any = {};
|
|
1292
|
+
|
|
1293
|
+
if (requestParameters.email !== undefined) {
|
|
1294
|
+
queryParameters['email'] = requestParameters.email;
|
|
1295
|
+
}
|
|
1296
|
+
|
|
1297
|
+
if (requestParameters.templateId !== undefined) {
|
|
1298
|
+
queryParameters['templateId'] = requestParameters.templateId;
|
|
1299
|
+
}
|
|
1300
|
+
|
|
1301
|
+
if (requestParameters.messageId !== undefined) {
|
|
1302
|
+
queryParameters['messageId'] = requestParameters.messageId;
|
|
1303
|
+
}
|
|
1304
|
+
|
|
1305
|
+
if (requestParameters.startDate !== undefined) {
|
|
1306
|
+
queryParameters['startDate'] = (requestParameters.startDate as any).toISOString().substring(0, 10);
|
|
1307
|
+
}
|
|
1308
|
+
|
|
1309
|
+
if (requestParameters.endDate !== undefined) {
|
|
1310
|
+
queryParameters['endDate'] = (requestParameters.endDate as any).toISOString().substring(0, 10);
|
|
1311
|
+
}
|
|
1312
|
+
|
|
1313
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1314
|
+
|
|
1315
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1316
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1317
|
+
}
|
|
1318
|
+
|
|
1319
|
+
const response = await this.request(
|
|
1320
|
+
{
|
|
1321
|
+
path: `/smtp/emails`,
|
|
1322
|
+
method: 'GET',
|
|
1323
|
+
headers: headerParameters,
|
|
1324
|
+
query: queryParameters,
|
|
1325
|
+
},
|
|
1326
|
+
initOverrides,
|
|
1327
|
+
);
|
|
1328
|
+
|
|
1329
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetTransacEmailsListFromJSON(jsonValue));
|
|
1330
|
+
}
|
|
1331
|
+
|
|
1332
|
+
/**
|
|
1333
|
+
* 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.
|
|
1334
|
+
* Get the list of transactional emails on the basis of allowed filters
|
|
1335
|
+
*/
|
|
1336
|
+
async getTransacEmailsList(
|
|
1337
|
+
requestParameters: GetTransacEmailsListRequest = {},
|
|
1338
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1339
|
+
): Promise<GetTransacEmailsList> {
|
|
1340
|
+
const response = await this.getTransacEmailsListRaw(requestParameters, initOverrides);
|
|
1341
|
+
return await response.value();
|
|
1342
|
+
}
|
|
1343
|
+
|
|
1344
|
+
/**
|
|
1345
|
+
* This endpoint is deprecated. Prefer v3/smtp/email instead.
|
|
1346
|
+
* Send a template
|
|
1347
|
+
* @deprecated
|
|
1348
|
+
*/
|
|
1349
|
+
async sendTemplateRaw(
|
|
1350
|
+
requestParameters: SendTemplateRequest,
|
|
1351
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1352
|
+
): Promise<runtime.ApiResponse<SendTemplateEmail>> {
|
|
1353
|
+
if (requestParameters.templateId === null || requestParameters.templateId === undefined) {
|
|
1354
|
+
throw new runtime.RequiredError(
|
|
1355
|
+
'templateId',
|
|
1356
|
+
'Required parameter requestParameters.templateId was null or undefined when calling sendTemplate.',
|
|
1357
|
+
);
|
|
1358
|
+
}
|
|
1359
|
+
|
|
1360
|
+
if (requestParameters.sendEmail === null || requestParameters.sendEmail === undefined) {
|
|
1361
|
+
throw new runtime.RequiredError(
|
|
1362
|
+
'sendEmail',
|
|
1363
|
+
'Required parameter requestParameters.sendEmail was null or undefined when calling sendTemplate.',
|
|
1364
|
+
);
|
|
1365
|
+
}
|
|
1366
|
+
|
|
1367
|
+
const queryParameters: any = {};
|
|
1368
|
+
|
|
1369
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1370
|
+
|
|
1371
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1372
|
+
|
|
1373
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1374
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1375
|
+
}
|
|
1376
|
+
|
|
1377
|
+
const response = await this.request(
|
|
1378
|
+
{
|
|
1379
|
+
path: `/smtp/templates/{templateId}/send`.replace(`{${'templateId'}}`, encodeURIComponent(String(requestParameters.templateId))),
|
|
1380
|
+
method: 'POST',
|
|
1381
|
+
headers: headerParameters,
|
|
1382
|
+
query: queryParameters,
|
|
1383
|
+
body: SendEmailToJSON(requestParameters.sendEmail),
|
|
1384
|
+
},
|
|
1385
|
+
initOverrides,
|
|
1386
|
+
);
|
|
1387
|
+
|
|
1388
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => SendTemplateEmailFromJSON(jsonValue));
|
|
1389
|
+
}
|
|
1390
|
+
|
|
1391
|
+
/**
|
|
1392
|
+
* This endpoint is deprecated. Prefer v3/smtp/email instead.
|
|
1393
|
+
* Send a template
|
|
1394
|
+
* @deprecated
|
|
1395
|
+
*/
|
|
1396
|
+
async sendTemplate(
|
|
1397
|
+
requestParameters: SendTemplateRequest,
|
|
1398
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1399
|
+
): Promise<SendTemplateEmail> {
|
|
1400
|
+
const response = await this.sendTemplateRaw(requestParameters, initOverrides);
|
|
1401
|
+
return await response.value();
|
|
1402
|
+
}
|
|
1403
|
+
|
|
1404
|
+
/**
|
|
1405
|
+
* Send a template to your test list
|
|
1406
|
+
*/
|
|
1407
|
+
async sendTestTemplateRaw(
|
|
1408
|
+
requestParameters: SendTestTemplateRequest,
|
|
1409
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1410
|
+
): Promise<runtime.ApiResponse<void>> {
|
|
1411
|
+
if (requestParameters.templateId === null || requestParameters.templateId === undefined) {
|
|
1412
|
+
throw new runtime.RequiredError(
|
|
1413
|
+
'templateId',
|
|
1414
|
+
'Required parameter requestParameters.templateId was null or undefined when calling sendTestTemplate.',
|
|
1415
|
+
);
|
|
1416
|
+
}
|
|
1417
|
+
|
|
1418
|
+
if (requestParameters.sendTestEmail === null || requestParameters.sendTestEmail === undefined) {
|
|
1419
|
+
throw new runtime.RequiredError(
|
|
1420
|
+
'sendTestEmail',
|
|
1421
|
+
'Required parameter requestParameters.sendTestEmail was null or undefined when calling sendTestTemplate.',
|
|
1422
|
+
);
|
|
1423
|
+
}
|
|
1424
|
+
|
|
1425
|
+
const queryParameters: any = {};
|
|
1426
|
+
|
|
1427
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1428
|
+
|
|
1429
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1430
|
+
|
|
1431
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1432
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1433
|
+
}
|
|
1434
|
+
|
|
1435
|
+
const response = await this.request(
|
|
1436
|
+
{
|
|
1437
|
+
path: `/smtp/templates/{templateId}/sendTest`.replace(
|
|
1438
|
+
`{${'templateId'}}`,
|
|
1439
|
+
encodeURIComponent(String(requestParameters.templateId)),
|
|
1440
|
+
),
|
|
1441
|
+
method: 'POST',
|
|
1442
|
+
headers: headerParameters,
|
|
1443
|
+
query: queryParameters,
|
|
1444
|
+
body: SendTestEmailToJSON(requestParameters.sendTestEmail),
|
|
1445
|
+
},
|
|
1446
|
+
initOverrides,
|
|
1447
|
+
);
|
|
1448
|
+
|
|
1449
|
+
return new runtime.VoidApiResponse(response);
|
|
1450
|
+
}
|
|
1451
|
+
|
|
1452
|
+
/**
|
|
1453
|
+
* Send a template to your test list
|
|
1454
|
+
*/
|
|
1455
|
+
async sendTestTemplate(
|
|
1456
|
+
requestParameters: SendTestTemplateRequest,
|
|
1457
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1458
|
+
): Promise<void> {
|
|
1459
|
+
await this.sendTestTemplateRaw(requestParameters, initOverrides);
|
|
1460
|
+
}
|
|
1461
|
+
|
|
1462
|
+
/**
|
|
1463
|
+
* Send a transactional email
|
|
1464
|
+
*/
|
|
1465
|
+
async sendTransacEmailRaw(
|
|
1466
|
+
requestParameters: SendTransacEmailRequest,
|
|
1467
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1468
|
+
): Promise<runtime.ApiResponse<CreateSmtpEmail>> {
|
|
1469
|
+
if (requestParameters.sendSmtpEmail === null || requestParameters.sendSmtpEmail === undefined) {
|
|
1470
|
+
throw new runtime.RequiredError(
|
|
1471
|
+
'sendSmtpEmail',
|
|
1472
|
+
'Required parameter requestParameters.sendSmtpEmail was null or undefined when calling sendTransacEmail.',
|
|
1473
|
+
);
|
|
1474
|
+
}
|
|
1475
|
+
|
|
1476
|
+
const queryParameters: any = {};
|
|
1477
|
+
|
|
1478
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1479
|
+
|
|
1480
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1481
|
+
|
|
1482
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1483
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1484
|
+
}
|
|
1485
|
+
|
|
1486
|
+
const response = await this.request(
|
|
1487
|
+
{
|
|
1488
|
+
path: `/smtp/email`,
|
|
1489
|
+
method: 'POST',
|
|
1490
|
+
headers: headerParameters,
|
|
1491
|
+
query: queryParameters,
|
|
1492
|
+
body: SendSmtpEmailToJSON(requestParameters.sendSmtpEmail),
|
|
1493
|
+
},
|
|
1494
|
+
initOverrides,
|
|
1495
|
+
);
|
|
1496
|
+
|
|
1497
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CreateSmtpEmailFromJSON(jsonValue));
|
|
1498
|
+
}
|
|
1499
|
+
|
|
1500
|
+
/**
|
|
1501
|
+
* Send a transactional email
|
|
1502
|
+
*/
|
|
1503
|
+
async sendTransacEmail(
|
|
1504
|
+
requestParameters: SendTransacEmailRequest,
|
|
1505
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1506
|
+
): Promise<CreateSmtpEmail> {
|
|
1507
|
+
const response = await this.sendTransacEmailRaw(requestParameters, initOverrides);
|
|
1508
|
+
return await response.value();
|
|
1509
|
+
}
|
|
1510
|
+
|
|
1511
|
+
/**
|
|
1512
|
+
* Unblock or resubscribe a transactional contact
|
|
1513
|
+
*/
|
|
1514
|
+
async smtpBlockedContactsEmailDeleteRaw(
|
|
1515
|
+
requestParameters: SmtpBlockedContactsEmailDeleteRequest,
|
|
1516
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1517
|
+
): Promise<runtime.ApiResponse<void>> {
|
|
1518
|
+
if (requestParameters.email === null || requestParameters.email === undefined) {
|
|
1519
|
+
throw new runtime.RequiredError(
|
|
1520
|
+
'email',
|
|
1521
|
+
'Required parameter requestParameters.email was null or undefined when calling smtpBlockedContactsEmailDelete.',
|
|
1522
|
+
);
|
|
1523
|
+
}
|
|
1524
|
+
|
|
1525
|
+
const queryParameters: any = {};
|
|
1526
|
+
|
|
1527
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1528
|
+
|
|
1529
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1530
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1531
|
+
}
|
|
1532
|
+
|
|
1533
|
+
const response = await this.request(
|
|
1534
|
+
{
|
|
1535
|
+
path: `/smtp/blockedContacts/{email}`.replace(`{${'email'}}`, encodeURIComponent(String(requestParameters.email))),
|
|
1536
|
+
method: 'DELETE',
|
|
1537
|
+
headers: headerParameters,
|
|
1538
|
+
query: queryParameters,
|
|
1539
|
+
},
|
|
1540
|
+
initOverrides,
|
|
1541
|
+
);
|
|
1542
|
+
|
|
1543
|
+
return new runtime.VoidApiResponse(response);
|
|
1544
|
+
}
|
|
1545
|
+
|
|
1546
|
+
/**
|
|
1547
|
+
* Unblock or resubscribe a transactional contact
|
|
1548
|
+
*/
|
|
1549
|
+
async smtpBlockedContactsEmailDelete(
|
|
1550
|
+
requestParameters: SmtpBlockedContactsEmailDeleteRequest,
|
|
1551
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1552
|
+
): Promise<void> {
|
|
1553
|
+
await this.smtpBlockedContactsEmailDeleteRaw(requestParameters, initOverrides);
|
|
1554
|
+
}
|
|
1555
|
+
|
|
1556
|
+
/**
|
|
1557
|
+
* Delete an SMTP transactional log
|
|
1558
|
+
*/
|
|
1559
|
+
async smtpLogMessageIdDeleteRaw(
|
|
1560
|
+
requestParameters: SmtpLogMessageIdDeleteRequest,
|
|
1561
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1562
|
+
): Promise<runtime.ApiResponse<void>> {
|
|
1563
|
+
if (requestParameters.messageId === null || requestParameters.messageId === undefined) {
|
|
1564
|
+
throw new runtime.RequiredError(
|
|
1565
|
+
'messageId',
|
|
1566
|
+
'Required parameter requestParameters.messageId was null or undefined when calling smtpLogMessageIdDelete.',
|
|
1567
|
+
);
|
|
1568
|
+
}
|
|
1569
|
+
|
|
1570
|
+
const queryParameters: any = {};
|
|
1571
|
+
|
|
1572
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1573
|
+
|
|
1574
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1575
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1576
|
+
}
|
|
1577
|
+
|
|
1578
|
+
const response = await this.request(
|
|
1579
|
+
{
|
|
1580
|
+
path: `/smtp/log/{messageId}`.replace(`{${'messageId'}}`, encodeURIComponent(String(requestParameters.messageId))),
|
|
1581
|
+
method: 'DELETE',
|
|
1582
|
+
headers: headerParameters,
|
|
1583
|
+
query: queryParameters,
|
|
1584
|
+
},
|
|
1585
|
+
initOverrides,
|
|
1586
|
+
);
|
|
1587
|
+
|
|
1588
|
+
return new runtime.VoidApiResponse(response);
|
|
1589
|
+
}
|
|
1590
|
+
|
|
1591
|
+
/**
|
|
1592
|
+
* Delete an SMTP transactional log
|
|
1593
|
+
*/
|
|
1594
|
+
async smtpLogMessageIdDelete(
|
|
1595
|
+
requestParameters: SmtpLogMessageIdDeleteRequest,
|
|
1596
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1597
|
+
): Promise<void> {
|
|
1598
|
+
await this.smtpLogMessageIdDeleteRaw(requestParameters, initOverrides);
|
|
1599
|
+
}
|
|
1600
|
+
|
|
1601
|
+
/**
|
|
1602
|
+
* Update an email template
|
|
1603
|
+
*/
|
|
1604
|
+
async updateSmtpTemplateRaw(
|
|
1605
|
+
requestParameters: UpdateSmtpTemplateRequest,
|
|
1606
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1607
|
+
): Promise<runtime.ApiResponse<void>> {
|
|
1608
|
+
if (requestParameters.templateId === null || requestParameters.templateId === undefined) {
|
|
1609
|
+
throw new runtime.RequiredError(
|
|
1610
|
+
'templateId',
|
|
1611
|
+
'Required parameter requestParameters.templateId was null or undefined when calling updateSmtpTemplate.',
|
|
1612
|
+
);
|
|
1613
|
+
}
|
|
1614
|
+
|
|
1615
|
+
if (requestParameters.smtpTemplate === null || requestParameters.smtpTemplate === undefined) {
|
|
1616
|
+
throw new runtime.RequiredError(
|
|
1617
|
+
'smtpTemplate',
|
|
1618
|
+
'Required parameter requestParameters.smtpTemplate was null or undefined when calling updateSmtpTemplate.',
|
|
1619
|
+
);
|
|
1620
|
+
}
|
|
1621
|
+
|
|
1622
|
+
const queryParameters: any = {};
|
|
1623
|
+
|
|
1624
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1625
|
+
|
|
1626
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1627
|
+
|
|
1628
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1629
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1630
|
+
}
|
|
1631
|
+
|
|
1632
|
+
const response = await this.request(
|
|
1633
|
+
{
|
|
1634
|
+
path: `/smtp/templates/{templateId}`.replace(`{${'templateId'}}`, encodeURIComponent(String(requestParameters.templateId))),
|
|
1635
|
+
method: 'PUT',
|
|
1636
|
+
headers: headerParameters,
|
|
1637
|
+
query: queryParameters,
|
|
1638
|
+
body: UpdateSmtpTemplateToJSON(requestParameters.smtpTemplate),
|
|
1639
|
+
},
|
|
1640
|
+
initOverrides,
|
|
1641
|
+
);
|
|
1642
|
+
|
|
1643
|
+
return new runtime.VoidApiResponse(response);
|
|
1644
|
+
}
|
|
1645
|
+
|
|
1646
|
+
/**
|
|
1647
|
+
* Update an email template
|
|
1648
|
+
*/
|
|
1649
|
+
async updateSmtpTemplate(
|
|
1650
|
+
requestParameters: UpdateSmtpTemplateRequest,
|
|
1651
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1652
|
+
): Promise<void> {
|
|
1653
|
+
await this.updateSmtpTemplateRaw(requestParameters, initOverrides);
|
|
1654
|
+
}
|
|
1655
|
+
}
|
|
1656
|
+
|
|
1657
|
+
/**
|
|
1658
|
+
* @export
|
|
1659
|
+
* @enum {string}
|
|
1660
|
+
*/
|
|
1661
|
+
export enum GetEmailEventReportEventEnum {
|
|
1662
|
+
Bounces = 'bounces',
|
|
1663
|
+
HardBounces = 'hardBounces',
|
|
1664
|
+
SoftBounces = 'softBounces',
|
|
1665
|
+
Delivered = 'delivered',
|
|
1666
|
+
Spam = 'spam',
|
|
1667
|
+
Requests = 'requests',
|
|
1668
|
+
Opened = 'opened',
|
|
1669
|
+
Clicks = 'clicks',
|
|
1670
|
+
Invalid = 'invalid',
|
|
1671
|
+
Deferred = 'deferred',
|
|
1672
|
+
Blocked = 'blocked',
|
|
1673
|
+
Unsubscribed = 'unsubscribed',
|
|
1674
|
+
}
|