@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,120 @@
|
|
|
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 { exists } from '../runtime.js';
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface CreateChild
|
|
20
|
+
*/
|
|
21
|
+
export interface CreateChild {
|
|
22
|
+
/**
|
|
23
|
+
* Email address to create the child account
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof CreateChild
|
|
26
|
+
*/
|
|
27
|
+
email: string;
|
|
28
|
+
/**
|
|
29
|
+
* First name to use to create the child account
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof CreateChild
|
|
32
|
+
*/
|
|
33
|
+
firstName: string;
|
|
34
|
+
/**
|
|
35
|
+
* Last name to use to create the child account
|
|
36
|
+
* @type {string}
|
|
37
|
+
* @memberof CreateChild
|
|
38
|
+
*/
|
|
39
|
+
lastName: string;
|
|
40
|
+
/**
|
|
41
|
+
* Company name to use to create the child account
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof CreateChild
|
|
44
|
+
*/
|
|
45
|
+
companyName: string;
|
|
46
|
+
/**
|
|
47
|
+
* Password for the child account to login
|
|
48
|
+
* @type {string}
|
|
49
|
+
* @memberof CreateChild
|
|
50
|
+
*/
|
|
51
|
+
password: string;
|
|
52
|
+
/**
|
|
53
|
+
* Language of the child account
|
|
54
|
+
* @type {string}
|
|
55
|
+
* @memberof CreateChild
|
|
56
|
+
*/
|
|
57
|
+
language?: CreateChildLanguageEnum;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* @export
|
|
62
|
+
* @enum {string}
|
|
63
|
+
*/
|
|
64
|
+
export enum CreateChildLanguageEnum {
|
|
65
|
+
Fr = 'fr',
|
|
66
|
+
Es = 'es',
|
|
67
|
+
Pt = 'pt',
|
|
68
|
+
It = 'it',
|
|
69
|
+
De = 'de',
|
|
70
|
+
En = 'en',
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
/**
|
|
74
|
+
* Check if a given object implements the CreateChild interface.
|
|
75
|
+
*/
|
|
76
|
+
export function instanceOfCreateChild(value: object): boolean {
|
|
77
|
+
let isInstance = true;
|
|
78
|
+
isInstance = isInstance && 'email' in value;
|
|
79
|
+
isInstance = isInstance && 'firstName' in value;
|
|
80
|
+
isInstance = isInstance && 'lastName' in value;
|
|
81
|
+
isInstance = isInstance && 'companyName' in value;
|
|
82
|
+
isInstance = isInstance && 'password' in value;
|
|
83
|
+
|
|
84
|
+
return isInstance;
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
export function CreateChildFromJSON(json: any): CreateChild {
|
|
88
|
+
return CreateChildFromJSONTyped(json, false);
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
export function CreateChildFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateChild {
|
|
92
|
+
if (json === undefined || json === null) {
|
|
93
|
+
return json;
|
|
94
|
+
}
|
|
95
|
+
return {
|
|
96
|
+
email: json['email'],
|
|
97
|
+
firstName: json['firstName'],
|
|
98
|
+
lastName: json['lastName'],
|
|
99
|
+
companyName: json['companyName'],
|
|
100
|
+
password: json['password'],
|
|
101
|
+
language: !exists(json, 'language') ? undefined : json['language'],
|
|
102
|
+
};
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
export function CreateChildToJSON(value?: CreateChild | null): any {
|
|
106
|
+
if (value === undefined) {
|
|
107
|
+
return undefined;
|
|
108
|
+
}
|
|
109
|
+
if (value === null) {
|
|
110
|
+
return null;
|
|
111
|
+
}
|
|
112
|
+
return {
|
|
113
|
+
email: value.email,
|
|
114
|
+
firstName: value.firstName,
|
|
115
|
+
lastName: value.lastName,
|
|
116
|
+
companyName: value.companyName,
|
|
117
|
+
password: value.password,
|
|
118
|
+
language: value.language,
|
|
119
|
+
};
|
|
120
|
+
}
|
|
@@ -0,0 +1,110 @@
|
|
|
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 { exists } from '../runtime.js';
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface CreateContact
|
|
20
|
+
*/
|
|
21
|
+
export interface CreateContact {
|
|
22
|
+
/**
|
|
23
|
+
* Email address of the user. Mandatory if "SMS" field is not passed in "attributes" parameter. Mobile Number in "SMS" field should be passed with proper country code. For example {"SMS":"+91xxxxxxxxxx"} or {"SMS":"0091xxxxxxxxxx"}
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof CreateContact
|
|
26
|
+
*/
|
|
27
|
+
email?: string;
|
|
28
|
+
/**
|
|
29
|
+
* Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {"FNAME":"Elly", "LNAME":"Roger"}
|
|
30
|
+
* @type {object}
|
|
31
|
+
* @memberof CreateContact
|
|
32
|
+
*/
|
|
33
|
+
attributes?: object;
|
|
34
|
+
/**
|
|
35
|
+
* Set this field to blacklist the contact for emails (emailBlacklisted = true)
|
|
36
|
+
* @type {boolean}
|
|
37
|
+
* @memberof CreateContact
|
|
38
|
+
*/
|
|
39
|
+
emailBlacklisted?: boolean;
|
|
40
|
+
/**
|
|
41
|
+
* Set this field to blacklist the contact for SMS (smsBlacklisted = true)
|
|
42
|
+
* @type {boolean}
|
|
43
|
+
* @memberof CreateContact
|
|
44
|
+
*/
|
|
45
|
+
smsBlacklisted?: boolean;
|
|
46
|
+
/**
|
|
47
|
+
* Ids of the lists to add the contact to
|
|
48
|
+
* @type {Array<number>}
|
|
49
|
+
* @memberof CreateContact
|
|
50
|
+
*/
|
|
51
|
+
listIds?: Array<number>;
|
|
52
|
+
/**
|
|
53
|
+
* Facilitate to update the existing contact in the same request (updateEnabled = true)
|
|
54
|
+
* @type {boolean}
|
|
55
|
+
* @memberof CreateContact
|
|
56
|
+
*/
|
|
57
|
+
updateEnabled?: boolean;
|
|
58
|
+
/**
|
|
59
|
+
* transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true )
|
|
60
|
+
* @type {Array<string>}
|
|
61
|
+
* @memberof CreateContact
|
|
62
|
+
*/
|
|
63
|
+
smtpBlacklistSender?: Array<string>;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
/**
|
|
67
|
+
* Check if a given object implements the CreateContact interface.
|
|
68
|
+
*/
|
|
69
|
+
export function instanceOfCreateContact(value: object): boolean {
|
|
70
|
+
let isInstance = true;
|
|
71
|
+
|
|
72
|
+
return isInstance;
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
export function CreateContactFromJSON(json: any): CreateContact {
|
|
76
|
+
return CreateContactFromJSONTyped(json, false);
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
export function CreateContactFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateContact {
|
|
80
|
+
if (json === undefined || json === null) {
|
|
81
|
+
return json;
|
|
82
|
+
}
|
|
83
|
+
return {
|
|
84
|
+
email: !exists(json, 'email') ? undefined : json['email'],
|
|
85
|
+
attributes: !exists(json, 'attributes') ? undefined : json['attributes'],
|
|
86
|
+
emailBlacklisted: !exists(json, 'emailBlacklisted') ? undefined : json['emailBlacklisted'],
|
|
87
|
+
smsBlacklisted: !exists(json, 'smsBlacklisted') ? undefined : json['smsBlacklisted'],
|
|
88
|
+
listIds: !exists(json, 'listIds') ? undefined : json['listIds'],
|
|
89
|
+
updateEnabled: !exists(json, 'updateEnabled') ? undefined : json['updateEnabled'],
|
|
90
|
+
smtpBlacklistSender: !exists(json, 'smtpBlacklistSender') ? undefined : json['smtpBlacklistSender'],
|
|
91
|
+
};
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
export function CreateContactToJSON(value?: CreateContact | null): any {
|
|
95
|
+
if (value === undefined) {
|
|
96
|
+
return undefined;
|
|
97
|
+
}
|
|
98
|
+
if (value === null) {
|
|
99
|
+
return null;
|
|
100
|
+
}
|
|
101
|
+
return {
|
|
102
|
+
email: value.email,
|
|
103
|
+
attributes: value.attributes,
|
|
104
|
+
emailBlacklisted: value.emailBlacklisted,
|
|
105
|
+
smsBlacklisted: value.smsBlacklisted,
|
|
106
|
+
listIds: value.listIds,
|
|
107
|
+
updateEnabled: value.updateEnabled,
|
|
108
|
+
smtpBlacklistSender: value.smtpBlacklistSender,
|
|
109
|
+
};
|
|
110
|
+
}
|
|
@@ -0,0 +1,106 @@
|
|
|
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 { exists } from '../runtime.js';
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface CreateDoiContact
|
|
20
|
+
*/
|
|
21
|
+
export interface CreateDoiContact {
|
|
22
|
+
/**
|
|
23
|
+
* Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes.
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof CreateDoiContact
|
|
26
|
+
*/
|
|
27
|
+
email: string;
|
|
28
|
+
/**
|
|
29
|
+
* Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'}
|
|
30
|
+
* @type {object}
|
|
31
|
+
* @memberof CreateDoiContact
|
|
32
|
+
*/
|
|
33
|
+
attributes?: object;
|
|
34
|
+
/**
|
|
35
|
+
* Lists under user account where contact should be added
|
|
36
|
+
* @type {Array<number>}
|
|
37
|
+
* @memberof CreateDoiContact
|
|
38
|
+
*/
|
|
39
|
+
includeListIds: Array<number>;
|
|
40
|
+
/**
|
|
41
|
+
* Lists under user account where contact should not be added
|
|
42
|
+
* @type {Array<number>}
|
|
43
|
+
* @memberof CreateDoiContact
|
|
44
|
+
*/
|
|
45
|
+
excludeListIds?: Array<number>;
|
|
46
|
+
/**
|
|
47
|
+
* Id of the Double opt-in (DOI) template
|
|
48
|
+
* @type {number}
|
|
49
|
+
* @memberof CreateDoiContact
|
|
50
|
+
*/
|
|
51
|
+
templateId: number;
|
|
52
|
+
/**
|
|
53
|
+
* URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}.
|
|
54
|
+
* @type {string}
|
|
55
|
+
* @memberof CreateDoiContact
|
|
56
|
+
*/
|
|
57
|
+
redirectionUrl: string;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* Check if a given object implements the CreateDoiContact interface.
|
|
62
|
+
*/
|
|
63
|
+
export function instanceOfCreateDoiContact(value: object): boolean {
|
|
64
|
+
let isInstance = true;
|
|
65
|
+
isInstance = isInstance && 'email' in value;
|
|
66
|
+
isInstance = isInstance && 'includeListIds' in value;
|
|
67
|
+
isInstance = isInstance && 'templateId' in value;
|
|
68
|
+
isInstance = isInstance && 'redirectionUrl' in value;
|
|
69
|
+
|
|
70
|
+
return isInstance;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export function CreateDoiContactFromJSON(json: any): CreateDoiContact {
|
|
74
|
+
return CreateDoiContactFromJSONTyped(json, false);
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
export function CreateDoiContactFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateDoiContact {
|
|
78
|
+
if (json === undefined || json === null) {
|
|
79
|
+
return json;
|
|
80
|
+
}
|
|
81
|
+
return {
|
|
82
|
+
email: json['email'],
|
|
83
|
+
attributes: !exists(json, 'attributes') ? undefined : json['attributes'],
|
|
84
|
+
includeListIds: json['includeListIds'],
|
|
85
|
+
excludeListIds: !exists(json, 'excludeListIds') ? undefined : json['excludeListIds'],
|
|
86
|
+
templateId: json['templateId'],
|
|
87
|
+
redirectionUrl: json['redirectionUrl'],
|
|
88
|
+
};
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
export function CreateDoiContactToJSON(value?: CreateDoiContact | null): any {
|
|
92
|
+
if (value === undefined) {
|
|
93
|
+
return undefined;
|
|
94
|
+
}
|
|
95
|
+
if (value === null) {
|
|
96
|
+
return null;
|
|
97
|
+
}
|
|
98
|
+
return {
|
|
99
|
+
email: value.email,
|
|
100
|
+
attributes: value.attributes,
|
|
101
|
+
includeListIds: value.includeListIds,
|
|
102
|
+
excludeListIds: value.excludeListIds,
|
|
103
|
+
templateId: value.templateId,
|
|
104
|
+
redirectionUrl: value.redirectionUrl,
|
|
105
|
+
};
|
|
106
|
+
}
|
|
@@ -0,0 +1,293 @@
|
|
|
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 { exists } from '../runtime.js';
|
|
15
|
+
import type { CreateEmailCampaignRecipients } from './CreateEmailCampaignRecipients.js';
|
|
16
|
+
import { CreateEmailCampaignRecipientsFromJSON, CreateEmailCampaignRecipientsToJSON } from './CreateEmailCampaignRecipients.js';
|
|
17
|
+
import type { CreateEmailCampaignSender } from './CreateEmailCampaignSender.js';
|
|
18
|
+
import { CreateEmailCampaignSenderFromJSON, CreateEmailCampaignSenderToJSON } from './CreateEmailCampaignSender.js';
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @export
|
|
23
|
+
* @interface CreateEmailCampaign
|
|
24
|
+
*/
|
|
25
|
+
export interface CreateEmailCampaign {
|
|
26
|
+
/**
|
|
27
|
+
* Tag of the campaign
|
|
28
|
+
* @type {string}
|
|
29
|
+
* @memberof CreateEmailCampaign
|
|
30
|
+
*/
|
|
31
|
+
tag?: string;
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {CreateEmailCampaignSender}
|
|
35
|
+
* @memberof CreateEmailCampaign
|
|
36
|
+
*/
|
|
37
|
+
sender: CreateEmailCampaignSender;
|
|
38
|
+
/**
|
|
39
|
+
* Name of the campaign
|
|
40
|
+
* @type {string}
|
|
41
|
+
* @memberof CreateEmailCampaign
|
|
42
|
+
*/
|
|
43
|
+
name: string;
|
|
44
|
+
/**
|
|
45
|
+
* Mandatory if htmlUrl and templateId are empty. Body of the message (HTML)
|
|
46
|
+
* @type {string}
|
|
47
|
+
* @memberof CreateEmailCampaign
|
|
48
|
+
*/
|
|
49
|
+
htmlContent?: string;
|
|
50
|
+
/**
|
|
51
|
+
* Mandatory if htmlContent and templateId are empty. Url to the message (HTML)
|
|
52
|
+
* @type {string}
|
|
53
|
+
* @memberof CreateEmailCampaign
|
|
54
|
+
*/
|
|
55
|
+
htmlUrl?: string;
|
|
56
|
+
/**
|
|
57
|
+
* Mandatory if htmlContent and htmlUrl are empty. Id of the transactional email template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature.
|
|
58
|
+
* @type {number}
|
|
59
|
+
* @memberof CreateEmailCampaign
|
|
60
|
+
*/
|
|
61
|
+
templateId?: number;
|
|
62
|
+
/**
|
|
63
|
+
* Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part).
|
|
64
|
+
* @type {Date}
|
|
65
|
+
* @memberof CreateEmailCampaign
|
|
66
|
+
*/
|
|
67
|
+
scheduledAt?: Date;
|
|
68
|
+
/**
|
|
69
|
+
* Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true.
|
|
70
|
+
* @type {string}
|
|
71
|
+
* @memberof CreateEmailCampaign
|
|
72
|
+
*/
|
|
73
|
+
subject?: string;
|
|
74
|
+
/**
|
|
75
|
+
* Email on which the campaign recipients will be able to reply to
|
|
76
|
+
* @type {string}
|
|
77
|
+
* @memberof CreateEmailCampaign
|
|
78
|
+
*/
|
|
79
|
+
replyTo?: string;
|
|
80
|
+
/**
|
|
81
|
+
* To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization
|
|
82
|
+
* @type {string}
|
|
83
|
+
* @memberof CreateEmailCampaign
|
|
84
|
+
*/
|
|
85
|
+
toField?: string;
|
|
86
|
+
/**
|
|
87
|
+
*
|
|
88
|
+
* @type {CreateEmailCampaignRecipients}
|
|
89
|
+
* @memberof CreateEmailCampaign
|
|
90
|
+
*/
|
|
91
|
+
recipients?: CreateEmailCampaignRecipients;
|
|
92
|
+
/**
|
|
93
|
+
* Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps
|
|
94
|
+
* @type {string}
|
|
95
|
+
* @memberof CreateEmailCampaign
|
|
96
|
+
*/
|
|
97
|
+
attachmentUrl?: string;
|
|
98
|
+
/**
|
|
99
|
+
* Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can not be sent to more than 5000 contacts
|
|
100
|
+
* @type {boolean}
|
|
101
|
+
* @memberof CreateEmailCampaign
|
|
102
|
+
*/
|
|
103
|
+
inlineImageActivation?: boolean;
|
|
104
|
+
/**
|
|
105
|
+
* Use true to enable the mirror link
|
|
106
|
+
* @type {boolean}
|
|
107
|
+
* @memberof CreateEmailCampaign
|
|
108
|
+
*/
|
|
109
|
+
mirrorActive?: boolean;
|
|
110
|
+
/**
|
|
111
|
+
* Footer of the email campaign
|
|
112
|
+
* @type {string}
|
|
113
|
+
* @memberof CreateEmailCampaign
|
|
114
|
+
*/
|
|
115
|
+
footer?: string;
|
|
116
|
+
/**
|
|
117
|
+
* Header of the email campaign
|
|
118
|
+
* @type {string}
|
|
119
|
+
* @memberof CreateEmailCampaign
|
|
120
|
+
*/
|
|
121
|
+
header?: string;
|
|
122
|
+
/**
|
|
123
|
+
* Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed
|
|
124
|
+
* @type {string}
|
|
125
|
+
* @memberof CreateEmailCampaign
|
|
126
|
+
*/
|
|
127
|
+
utmCampaign?: string;
|
|
128
|
+
/**
|
|
129
|
+
* Pass the set of attributes to customize the type classic campaign. For example, {"FNAME":"Joe", "LNAME":"Doe"}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField'
|
|
130
|
+
* @type {object}
|
|
131
|
+
* @memberof CreateEmailCampaign
|
|
132
|
+
*/
|
|
133
|
+
params?: object;
|
|
134
|
+
/**
|
|
135
|
+
* Set this to true if you want to send your campaign at best time.
|
|
136
|
+
* @type {boolean}
|
|
137
|
+
* @memberof CreateEmailCampaign
|
|
138
|
+
*/
|
|
139
|
+
sendAtBestTime?: boolean;
|
|
140
|
+
/**
|
|
141
|
+
* Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered when abTesting is set to true. 'subjectA' & 'subjectB' are mandatory together & 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B
|
|
142
|
+
* @type {boolean}
|
|
143
|
+
* @memberof CreateEmailCampaign
|
|
144
|
+
*/
|
|
145
|
+
abTesting?: boolean;
|
|
146
|
+
/**
|
|
147
|
+
* Subject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value
|
|
148
|
+
* @type {string}
|
|
149
|
+
* @memberof CreateEmailCampaign
|
|
150
|
+
*/
|
|
151
|
+
subjectA?: string;
|
|
152
|
+
/**
|
|
153
|
+
* Subject B of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value
|
|
154
|
+
* @type {string}
|
|
155
|
+
* @memberof CreateEmailCampaign
|
|
156
|
+
*/
|
|
157
|
+
subjectB?: string;
|
|
158
|
+
/**
|
|
159
|
+
* Add the size of your test groups. Mandatory if abTesting = true & 'recipients' is passed. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else
|
|
160
|
+
* @type {number}
|
|
161
|
+
* @memberof CreateEmailCampaign
|
|
162
|
+
*/
|
|
163
|
+
splitRule?: number;
|
|
164
|
+
/**
|
|
165
|
+
* Choose the metrics that will determinate the winning version. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed
|
|
166
|
+
* @type {string}
|
|
167
|
+
* @memberof CreateEmailCampaign
|
|
168
|
+
*/
|
|
169
|
+
winnerCriteria?: CreateEmailCampaignWinnerCriteriaEnum;
|
|
170
|
+
/**
|
|
171
|
+
* Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed
|
|
172
|
+
* @type {number}
|
|
173
|
+
* @memberof CreateEmailCampaign
|
|
174
|
+
*/
|
|
175
|
+
winnerDelay?: number;
|
|
176
|
+
/**
|
|
177
|
+
* Available for dedicated ip clients. Set this to true if you wish to warm up your ip.
|
|
178
|
+
* @type {boolean}
|
|
179
|
+
* @memberof CreateEmailCampaign
|
|
180
|
+
*/
|
|
181
|
+
ipWarmupEnable?: boolean;
|
|
182
|
+
/**
|
|
183
|
+
* Mandatory if ipWarmupEnable is set to true. Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000.
|
|
184
|
+
* @type {number}
|
|
185
|
+
* @memberof CreateEmailCampaign
|
|
186
|
+
*/
|
|
187
|
+
initialQuota?: number;
|
|
188
|
+
/**
|
|
189
|
+
* Mandatory if ipWarmupEnable is set to true. Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%.
|
|
190
|
+
* @type {number}
|
|
191
|
+
* @memberof CreateEmailCampaign
|
|
192
|
+
*/
|
|
193
|
+
increaseRate?: number;
|
|
194
|
+
}
|
|
195
|
+
|
|
196
|
+
/**
|
|
197
|
+
* @export
|
|
198
|
+
* @enum {string}
|
|
199
|
+
*/
|
|
200
|
+
export enum CreateEmailCampaignWinnerCriteriaEnum {
|
|
201
|
+
Open = 'open',
|
|
202
|
+
Click = 'click',
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
/**
|
|
206
|
+
* Check if a given object implements the CreateEmailCampaign interface.
|
|
207
|
+
*/
|
|
208
|
+
export function instanceOfCreateEmailCampaign(value: object): boolean {
|
|
209
|
+
let isInstance = true;
|
|
210
|
+
isInstance = isInstance && 'sender' in value;
|
|
211
|
+
isInstance = isInstance && 'name' in value;
|
|
212
|
+
|
|
213
|
+
return isInstance;
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
export function CreateEmailCampaignFromJSON(json: any): CreateEmailCampaign {
|
|
217
|
+
return CreateEmailCampaignFromJSONTyped(json, false);
|
|
218
|
+
}
|
|
219
|
+
|
|
220
|
+
export function CreateEmailCampaignFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateEmailCampaign {
|
|
221
|
+
if (json === undefined || json === null) {
|
|
222
|
+
return json;
|
|
223
|
+
}
|
|
224
|
+
return {
|
|
225
|
+
tag: !exists(json, 'tag') ? undefined : json['tag'],
|
|
226
|
+
sender: CreateEmailCampaignSenderFromJSON(json['sender']),
|
|
227
|
+
name: json['name'],
|
|
228
|
+
htmlContent: !exists(json, 'htmlContent') ? undefined : json['htmlContent'],
|
|
229
|
+
htmlUrl: !exists(json, 'htmlUrl') ? undefined : json['htmlUrl'],
|
|
230
|
+
templateId: !exists(json, 'templateId') ? undefined : json['templateId'],
|
|
231
|
+
scheduledAt: !exists(json, 'scheduledAt') ? undefined : new Date(json['scheduledAt']),
|
|
232
|
+
subject: !exists(json, 'subject') ? undefined : json['subject'],
|
|
233
|
+
replyTo: !exists(json, 'replyTo') ? undefined : json['replyTo'],
|
|
234
|
+
toField: !exists(json, 'toField') ? undefined : json['toField'],
|
|
235
|
+
recipients: !exists(json, 'recipients') ? undefined : CreateEmailCampaignRecipientsFromJSON(json['recipients']),
|
|
236
|
+
attachmentUrl: !exists(json, 'attachmentUrl') ? undefined : json['attachmentUrl'],
|
|
237
|
+
inlineImageActivation: !exists(json, 'inlineImageActivation') ? undefined : json['inlineImageActivation'],
|
|
238
|
+
mirrorActive: !exists(json, 'mirrorActive') ? undefined : json['mirrorActive'],
|
|
239
|
+
footer: !exists(json, 'footer') ? undefined : json['footer'],
|
|
240
|
+
header: !exists(json, 'header') ? undefined : json['header'],
|
|
241
|
+
utmCampaign: !exists(json, 'utmCampaign') ? undefined : json['utmCampaign'],
|
|
242
|
+
params: !exists(json, 'params') ? undefined : json['params'],
|
|
243
|
+
sendAtBestTime: !exists(json, 'sendAtBestTime') ? undefined : json['sendAtBestTime'],
|
|
244
|
+
abTesting: !exists(json, 'abTesting') ? undefined : json['abTesting'],
|
|
245
|
+
subjectA: !exists(json, 'subjectA') ? undefined : json['subjectA'],
|
|
246
|
+
subjectB: !exists(json, 'subjectB') ? undefined : json['subjectB'],
|
|
247
|
+
splitRule: !exists(json, 'splitRule') ? undefined : json['splitRule'],
|
|
248
|
+
winnerCriteria: !exists(json, 'winnerCriteria') ? undefined : json['winnerCriteria'],
|
|
249
|
+
winnerDelay: !exists(json, 'winnerDelay') ? undefined : json['winnerDelay'],
|
|
250
|
+
ipWarmupEnable: !exists(json, 'ipWarmupEnable') ? undefined : json['ipWarmupEnable'],
|
|
251
|
+
initialQuota: !exists(json, 'initialQuota') ? undefined : json['initialQuota'],
|
|
252
|
+
increaseRate: !exists(json, 'increaseRate') ? undefined : json['increaseRate'],
|
|
253
|
+
};
|
|
254
|
+
}
|
|
255
|
+
|
|
256
|
+
export function CreateEmailCampaignToJSON(value?: CreateEmailCampaign | null): any {
|
|
257
|
+
if (value === undefined) {
|
|
258
|
+
return undefined;
|
|
259
|
+
}
|
|
260
|
+
if (value === null) {
|
|
261
|
+
return null;
|
|
262
|
+
}
|
|
263
|
+
return {
|
|
264
|
+
tag: value.tag,
|
|
265
|
+
sender: CreateEmailCampaignSenderToJSON(value.sender),
|
|
266
|
+
name: value.name,
|
|
267
|
+
htmlContent: value.htmlContent,
|
|
268
|
+
htmlUrl: value.htmlUrl,
|
|
269
|
+
templateId: value.templateId,
|
|
270
|
+
scheduledAt: value.scheduledAt === undefined ? undefined : value.scheduledAt.toISOString(),
|
|
271
|
+
subject: value.subject,
|
|
272
|
+
replyTo: value.replyTo,
|
|
273
|
+
toField: value.toField,
|
|
274
|
+
recipients: CreateEmailCampaignRecipientsToJSON(value.recipients),
|
|
275
|
+
attachmentUrl: value.attachmentUrl,
|
|
276
|
+
inlineImageActivation: value.inlineImageActivation,
|
|
277
|
+
mirrorActive: value.mirrorActive,
|
|
278
|
+
footer: value.footer,
|
|
279
|
+
header: value.header,
|
|
280
|
+
utmCampaign: value.utmCampaign,
|
|
281
|
+
params: value.params,
|
|
282
|
+
sendAtBestTime: value.sendAtBestTime,
|
|
283
|
+
abTesting: value.abTesting,
|
|
284
|
+
subjectA: value.subjectA,
|
|
285
|
+
subjectB: value.subjectB,
|
|
286
|
+
splitRule: value.splitRule,
|
|
287
|
+
winnerCriteria: value.winnerCriteria,
|
|
288
|
+
winnerDelay: value.winnerDelay,
|
|
289
|
+
ipWarmupEnable: value.ipWarmupEnable,
|
|
290
|
+
initialQuota: value.initialQuota,
|
|
291
|
+
increaseRate: value.increaseRate,
|
|
292
|
+
};
|
|
293
|
+
}
|