@bitblit/ratchet-misc 6.0.145-alpha → 6.0.147-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 +4 -3
- 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,94 @@
|
|
|
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 UpdateChild
|
|
20
|
+
*/
|
|
21
|
+
export interface UpdateChild {
|
|
22
|
+
/**
|
|
23
|
+
* New Email address to update the child account
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof UpdateChild
|
|
26
|
+
*/
|
|
27
|
+
email?: string;
|
|
28
|
+
/**
|
|
29
|
+
* New First name to use to update the child account
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof UpdateChild
|
|
32
|
+
*/
|
|
33
|
+
firstName?: string;
|
|
34
|
+
/**
|
|
35
|
+
* New Last name to use to update the child account
|
|
36
|
+
* @type {string}
|
|
37
|
+
* @memberof UpdateChild
|
|
38
|
+
*/
|
|
39
|
+
lastName?: string;
|
|
40
|
+
/**
|
|
41
|
+
* New Company name to use to update the child account
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof UpdateChild
|
|
44
|
+
*/
|
|
45
|
+
companyName?: string;
|
|
46
|
+
/**
|
|
47
|
+
* New password for the child account to login
|
|
48
|
+
* @type {string}
|
|
49
|
+
* @memberof UpdateChild
|
|
50
|
+
*/
|
|
51
|
+
password?: string;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* Check if a given object implements the UpdateChild interface.
|
|
56
|
+
*/
|
|
57
|
+
export function instanceOfUpdateChild(value: object): boolean {
|
|
58
|
+
let isInstance = true;
|
|
59
|
+
|
|
60
|
+
return isInstance;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
export function UpdateChildFromJSON(json: any): UpdateChild {
|
|
64
|
+
return UpdateChildFromJSONTyped(json, false);
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
export function UpdateChildFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateChild {
|
|
68
|
+
if (json === undefined || json === null) {
|
|
69
|
+
return json;
|
|
70
|
+
}
|
|
71
|
+
return {
|
|
72
|
+
email: !exists(json, 'email') ? undefined : json['email'],
|
|
73
|
+
firstName: !exists(json, 'firstName') ? undefined : json['firstName'],
|
|
74
|
+
lastName: !exists(json, 'lastName') ? undefined : json['lastName'],
|
|
75
|
+
companyName: !exists(json, 'companyName') ? undefined : json['companyName'],
|
|
76
|
+
password: !exists(json, 'password') ? undefined : json['password'],
|
|
77
|
+
};
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
export function UpdateChildToJSON(value?: UpdateChild | null): any {
|
|
81
|
+
if (value === undefined) {
|
|
82
|
+
return undefined;
|
|
83
|
+
}
|
|
84
|
+
if (value === null) {
|
|
85
|
+
return null;
|
|
86
|
+
}
|
|
87
|
+
return {
|
|
88
|
+
email: value.email,
|
|
89
|
+
firstName: value.firstName,
|
|
90
|
+
lastName: value.lastName,
|
|
91
|
+
companyName: value.companyName,
|
|
92
|
+
password: value.password,
|
|
93
|
+
};
|
|
94
|
+
}
|
|
@@ -0,0 +1,86 @@
|
|
|
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 UpdateChildAccountStatus
|
|
20
|
+
*/
|
|
21
|
+
export interface UpdateChildAccountStatus {
|
|
22
|
+
/**
|
|
23
|
+
* Status of Transactional Email Platform activation for your account (true=enabled, false=disabled)
|
|
24
|
+
* @type {boolean}
|
|
25
|
+
* @memberof UpdateChildAccountStatus
|
|
26
|
+
*/
|
|
27
|
+
transactionalEmail?: boolean;
|
|
28
|
+
/**
|
|
29
|
+
* Status of Transactional SMS Platform activation for your account (true=enabled, false=disabled)
|
|
30
|
+
* @type {boolean}
|
|
31
|
+
* @memberof UpdateChildAccountStatus
|
|
32
|
+
*/
|
|
33
|
+
transactionalSms?: boolean;
|
|
34
|
+
/**
|
|
35
|
+
* Status of Marketing Automation Platform activation for your account (true=enabled, false=disabled)
|
|
36
|
+
* @type {boolean}
|
|
37
|
+
* @memberof UpdateChildAccountStatus
|
|
38
|
+
*/
|
|
39
|
+
marketingAutomation?: boolean;
|
|
40
|
+
/**
|
|
41
|
+
* Status of SMS Campaign Platform activation for your account (true=enabled, false=disabled)
|
|
42
|
+
* @type {boolean}
|
|
43
|
+
* @memberof UpdateChildAccountStatus
|
|
44
|
+
*/
|
|
45
|
+
smsCampaign?: boolean;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* Check if a given object implements the UpdateChildAccountStatus interface.
|
|
50
|
+
*/
|
|
51
|
+
export function instanceOfUpdateChildAccountStatus(value: object): boolean {
|
|
52
|
+
let isInstance = true;
|
|
53
|
+
|
|
54
|
+
return isInstance;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
export function UpdateChildAccountStatusFromJSON(json: any): UpdateChildAccountStatus {
|
|
58
|
+
return UpdateChildAccountStatusFromJSONTyped(json, false);
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
export function UpdateChildAccountStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateChildAccountStatus {
|
|
62
|
+
if (json === undefined || json === null) {
|
|
63
|
+
return json;
|
|
64
|
+
}
|
|
65
|
+
return {
|
|
66
|
+
transactionalEmail: !exists(json, 'transactionalEmail') ? undefined : json['transactionalEmail'],
|
|
67
|
+
transactionalSms: !exists(json, 'transactionalSms') ? undefined : json['transactionalSms'],
|
|
68
|
+
marketingAutomation: !exists(json, 'marketingAutomation') ? undefined : json['marketingAutomation'],
|
|
69
|
+
smsCampaign: !exists(json, 'smsCampaign') ? undefined : json['smsCampaign'],
|
|
70
|
+
};
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export function UpdateChildAccountStatusToJSON(value?: UpdateChildAccountStatus | null): any {
|
|
74
|
+
if (value === undefined) {
|
|
75
|
+
return undefined;
|
|
76
|
+
}
|
|
77
|
+
if (value === null) {
|
|
78
|
+
return null;
|
|
79
|
+
}
|
|
80
|
+
return {
|
|
81
|
+
transactionalEmail: value.transactionalEmail,
|
|
82
|
+
transactionalSms: value.transactionalSms,
|
|
83
|
+
marketingAutomation: value.marketingAutomation,
|
|
84
|
+
smsCampaign: value.smsCampaign,
|
|
85
|
+
};
|
|
86
|
+
}
|
|
@@ -0,0 +1,62 @@
|
|
|
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 UpdateChildDomain
|
|
20
|
+
*/
|
|
21
|
+
export interface UpdateChildDomain {
|
|
22
|
+
/**
|
|
23
|
+
* Value for the sender domain that will replace the existing domain
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof UpdateChildDomain
|
|
26
|
+
*/
|
|
27
|
+
domain?: string;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
/**
|
|
31
|
+
* Check if a given object implements the UpdateChildDomain interface.
|
|
32
|
+
*/
|
|
33
|
+
export function instanceOfUpdateChildDomain(value: object): boolean {
|
|
34
|
+
let isInstance = true;
|
|
35
|
+
|
|
36
|
+
return isInstance;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
export function UpdateChildDomainFromJSON(json: any): UpdateChildDomain {
|
|
40
|
+
return UpdateChildDomainFromJSONTyped(json, false);
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
export function UpdateChildDomainFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateChildDomain {
|
|
44
|
+
if (json === undefined || json === null) {
|
|
45
|
+
return json;
|
|
46
|
+
}
|
|
47
|
+
return {
|
|
48
|
+
domain: !exists(json, 'domain') ? undefined : json['domain'],
|
|
49
|
+
};
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
export function UpdateChildDomainToJSON(value?: UpdateChildDomain | null): any {
|
|
53
|
+
if (value === undefined) {
|
|
54
|
+
return undefined;
|
|
55
|
+
}
|
|
56
|
+
if (value === null) {
|
|
57
|
+
return null;
|
|
58
|
+
}
|
|
59
|
+
return {
|
|
60
|
+
domain: value.domain,
|
|
61
|
+
};
|
|
62
|
+
}
|
|
@@ -0,0 +1,102 @@
|
|
|
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 UpdateContact
|
|
20
|
+
*/
|
|
21
|
+
export interface UpdateContact {
|
|
22
|
+
/**
|
|
23
|
+
* Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, `{ "EMAIL":"newemail@domain.com", "FNAME":"Ellie", "LNAME":"Roger"}`. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in "SMS" field should be passed with proper country code. For example {"SMS":"+91xxxxxxxxxx"} or {"SMS":"0091xxxxxxxxxx"}
|
|
24
|
+
* @type {object}
|
|
25
|
+
* @memberof UpdateContact
|
|
26
|
+
*/
|
|
27
|
+
attributes?: object;
|
|
28
|
+
/**
|
|
29
|
+
* Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true)
|
|
30
|
+
* @type {boolean}
|
|
31
|
+
* @memberof UpdateContact
|
|
32
|
+
*/
|
|
33
|
+
emailBlacklisted?: boolean;
|
|
34
|
+
/**
|
|
35
|
+
* Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true)
|
|
36
|
+
* @type {boolean}
|
|
37
|
+
* @memberof UpdateContact
|
|
38
|
+
*/
|
|
39
|
+
smsBlacklisted?: boolean;
|
|
40
|
+
/**
|
|
41
|
+
* Ids of the lists to add the contact to
|
|
42
|
+
* @type {Array<number>}
|
|
43
|
+
* @memberof UpdateContact
|
|
44
|
+
*/
|
|
45
|
+
listIds?: Array<number>;
|
|
46
|
+
/**
|
|
47
|
+
* Ids of the lists to remove the contact from
|
|
48
|
+
* @type {Array<number>}
|
|
49
|
+
* @memberof UpdateContact
|
|
50
|
+
*/
|
|
51
|
+
unlinkListIds?: Array<number>;
|
|
52
|
+
/**
|
|
53
|
+
* transactional email forbidden sender for contact. Use only for email Contact
|
|
54
|
+
* @type {Array<string>}
|
|
55
|
+
* @memberof UpdateContact
|
|
56
|
+
*/
|
|
57
|
+
smtpBlacklistSender?: Array<string>;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* Check if a given object implements the UpdateContact interface.
|
|
62
|
+
*/
|
|
63
|
+
export function instanceOfUpdateContact(value: object): boolean {
|
|
64
|
+
let isInstance = true;
|
|
65
|
+
|
|
66
|
+
return isInstance;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
export function UpdateContactFromJSON(json: any): UpdateContact {
|
|
70
|
+
return UpdateContactFromJSONTyped(json, false);
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export function UpdateContactFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateContact {
|
|
74
|
+
if (json === undefined || json === null) {
|
|
75
|
+
return json;
|
|
76
|
+
}
|
|
77
|
+
return {
|
|
78
|
+
attributes: !exists(json, 'attributes') ? undefined : json['attributes'],
|
|
79
|
+
emailBlacklisted: !exists(json, 'emailBlacklisted') ? undefined : json['emailBlacklisted'],
|
|
80
|
+
smsBlacklisted: !exists(json, 'smsBlacklisted') ? undefined : json['smsBlacklisted'],
|
|
81
|
+
listIds: !exists(json, 'listIds') ? undefined : json['listIds'],
|
|
82
|
+
unlinkListIds: !exists(json, 'unlinkListIds') ? undefined : json['unlinkListIds'],
|
|
83
|
+
smtpBlacklistSender: !exists(json, 'smtpBlacklistSender') ? undefined : json['smtpBlacklistSender'],
|
|
84
|
+
};
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
export function UpdateContactToJSON(value?: UpdateContact | null): any {
|
|
88
|
+
if (value === undefined) {
|
|
89
|
+
return undefined;
|
|
90
|
+
}
|
|
91
|
+
if (value === null) {
|
|
92
|
+
return null;
|
|
93
|
+
}
|
|
94
|
+
return {
|
|
95
|
+
attributes: value.attributes,
|
|
96
|
+
emailBlacklisted: value.emailBlacklisted,
|
|
97
|
+
smsBlacklisted: value.smsBlacklisted,
|
|
98
|
+
listIds: value.listIds,
|
|
99
|
+
unlinkListIds: value.unlinkListIds,
|
|
100
|
+
smtpBlacklistSender: value.smtpBlacklistSender,
|
|
101
|
+
};
|
|
102
|
+
}
|
|
@@ -0,0 +1,291 @@
|
|
|
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 { UpdateEmailCampaignRecipients } from './UpdateEmailCampaignRecipients.js';
|
|
16
|
+
import { UpdateEmailCampaignRecipientsFromJSON, UpdateEmailCampaignRecipientsToJSON } from './UpdateEmailCampaignRecipients.js';
|
|
17
|
+
import type { UpdateEmailCampaignSender } from './UpdateEmailCampaignSender.js';
|
|
18
|
+
import { UpdateEmailCampaignSenderFromJSON, UpdateEmailCampaignSenderToJSON } from './UpdateEmailCampaignSender.js';
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @export
|
|
23
|
+
* @interface UpdateEmailCampaign
|
|
24
|
+
*/
|
|
25
|
+
export interface UpdateEmailCampaign {
|
|
26
|
+
/**
|
|
27
|
+
* Tag of the campaign
|
|
28
|
+
* @type {string}
|
|
29
|
+
* @memberof UpdateEmailCampaign
|
|
30
|
+
*/
|
|
31
|
+
tag?: string;
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {UpdateEmailCampaignSender}
|
|
35
|
+
* @memberof UpdateEmailCampaign
|
|
36
|
+
*/
|
|
37
|
+
sender?: UpdateEmailCampaignSender;
|
|
38
|
+
/**
|
|
39
|
+
* Name of the campaign
|
|
40
|
+
* @type {string}
|
|
41
|
+
* @memberof UpdateEmailCampaign
|
|
42
|
+
*/
|
|
43
|
+
name?: string;
|
|
44
|
+
/**
|
|
45
|
+
* Body of the message (HTML version). REQUIRED if htmlUrl is empty
|
|
46
|
+
* @type {string}
|
|
47
|
+
* @memberof UpdateEmailCampaign
|
|
48
|
+
*/
|
|
49
|
+
htmlContent?: string;
|
|
50
|
+
/**
|
|
51
|
+
* Url which contents the body of the email message. REQUIRED if htmlContent is empty
|
|
52
|
+
* @type {string}
|
|
53
|
+
* @memberof UpdateEmailCampaign
|
|
54
|
+
*/
|
|
55
|
+
htmlUrl?: string;
|
|
56
|
+
/**
|
|
57
|
+
* UTC date-time on which the campaign has to run (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).
|
|
58
|
+
* @type {Date}
|
|
59
|
+
* @memberof UpdateEmailCampaign
|
|
60
|
+
*/
|
|
61
|
+
scheduledAt?: Date;
|
|
62
|
+
/**
|
|
63
|
+
* Subject of the campaign
|
|
64
|
+
* @type {string}
|
|
65
|
+
* @memberof UpdateEmailCampaign
|
|
66
|
+
*/
|
|
67
|
+
subject?: string;
|
|
68
|
+
/**
|
|
69
|
+
* Email on which campaign recipients will be able to reply to
|
|
70
|
+
* @type {string}
|
|
71
|
+
* @memberof UpdateEmailCampaign
|
|
72
|
+
*/
|
|
73
|
+
replyTo?: string;
|
|
74
|
+
/**
|
|
75
|
+
* 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
|
|
76
|
+
* @type {string}
|
|
77
|
+
* @memberof UpdateEmailCampaign
|
|
78
|
+
*/
|
|
79
|
+
toField?: string;
|
|
80
|
+
/**
|
|
81
|
+
*
|
|
82
|
+
* @type {UpdateEmailCampaignRecipients}
|
|
83
|
+
* @memberof UpdateEmailCampaign
|
|
84
|
+
*/
|
|
85
|
+
recipients?: UpdateEmailCampaignRecipients;
|
|
86
|
+
/**
|
|
87
|
+
* 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
|
|
88
|
+
* @type {string}
|
|
89
|
+
* @memberof UpdateEmailCampaign
|
|
90
|
+
*/
|
|
91
|
+
attachmentUrl?: string;
|
|
92
|
+
/**
|
|
93
|
+
* Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than 4MB with images embedded in the email. Campaigns with the images embedded in the email must be sent to less than 5000 contacts.
|
|
94
|
+
* @type {boolean}
|
|
95
|
+
* @memberof UpdateEmailCampaign
|
|
96
|
+
*/
|
|
97
|
+
inlineImageActivation?: boolean;
|
|
98
|
+
/**
|
|
99
|
+
* Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign
|
|
100
|
+
* @type {boolean}
|
|
101
|
+
* @memberof UpdateEmailCampaign
|
|
102
|
+
*/
|
|
103
|
+
mirrorActive?: boolean;
|
|
104
|
+
/**
|
|
105
|
+
* FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times
|
|
106
|
+
* @type {boolean}
|
|
107
|
+
* @memberof UpdateEmailCampaign
|
|
108
|
+
*/
|
|
109
|
+
recurring?: boolean;
|
|
110
|
+
/**
|
|
111
|
+
* Footer of the email campaign
|
|
112
|
+
* @type {string}
|
|
113
|
+
* @memberof UpdateEmailCampaign
|
|
114
|
+
*/
|
|
115
|
+
footer?: string;
|
|
116
|
+
/**
|
|
117
|
+
* Header of the email campaign
|
|
118
|
+
* @type {string}
|
|
119
|
+
* @memberof UpdateEmailCampaign
|
|
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 UpdateEmailCampaign
|
|
126
|
+
*/
|
|
127
|
+
utmCampaign?: string;
|
|
128
|
+
/**
|
|
129
|
+
* Pass the set of attributes to customize the type 'classic' campaign. For example, {"FNAME":"Joe", "LNAME":"Doe"}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField'
|
|
130
|
+
* @type {object}
|
|
131
|
+
* @memberof UpdateEmailCampaign
|
|
132
|
+
*/
|
|
133
|
+
params?: object;
|
|
134
|
+
/**
|
|
135
|
+
* Set this to true if you want to send your campaign at best time. Note:- if true, warmup ip will be disabled.
|
|
136
|
+
* @type {boolean}
|
|
137
|
+
* @memberof UpdateEmailCampaign
|
|
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 if abTesting is set to true. '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 UpdateEmailCampaign
|
|
144
|
+
*/
|
|
145
|
+
abTesting?: boolean;
|
|
146
|
+
/**
|
|
147
|
+
* Subject A of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value
|
|
148
|
+
* @type {string}
|
|
149
|
+
* @memberof UpdateEmailCampaign
|
|
150
|
+
*/
|
|
151
|
+
subjectA?: string;
|
|
152
|
+
/**
|
|
153
|
+
* Subject B of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value
|
|
154
|
+
* @type {string}
|
|
155
|
+
* @memberof UpdateEmailCampaign
|
|
156
|
+
*/
|
|
157
|
+
subjectB?: string;
|
|
158
|
+
/**
|
|
159
|
+
* Add the size of your test groups. Considered if abTesting = true. 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 UpdateEmailCampaign
|
|
162
|
+
*/
|
|
163
|
+
splitRule?: number;
|
|
164
|
+
/**
|
|
165
|
+
* Choose the metrics that will determinate the winning version. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed or alreday exist in record
|
|
166
|
+
* @type {string}
|
|
167
|
+
* @memberof UpdateEmailCampaign
|
|
168
|
+
*/
|
|
169
|
+
winnerCriteria?: UpdateEmailCampaignWinnerCriteriaEnum;
|
|
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. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed or alreday exist in record
|
|
172
|
+
* @type {number}
|
|
173
|
+
* @memberof UpdateEmailCampaign
|
|
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 UpdateEmailCampaign
|
|
180
|
+
*/
|
|
181
|
+
ipWarmupEnable?: boolean;
|
|
182
|
+
/**
|
|
183
|
+
* 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 UpdateEmailCampaign
|
|
186
|
+
*/
|
|
187
|
+
initialQuota?: number;
|
|
188
|
+
/**
|
|
189
|
+
* 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 UpdateEmailCampaign
|
|
192
|
+
*/
|
|
193
|
+
increaseRate?: number;
|
|
194
|
+
}
|
|
195
|
+
|
|
196
|
+
/**
|
|
197
|
+
* @export
|
|
198
|
+
* @enum {string}
|
|
199
|
+
*/
|
|
200
|
+
export enum UpdateEmailCampaignWinnerCriteriaEnum {
|
|
201
|
+
Open = 'open',
|
|
202
|
+
Click = 'click',
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
/**
|
|
206
|
+
* Check if a given object implements the UpdateEmailCampaign interface.
|
|
207
|
+
*/
|
|
208
|
+
export function instanceOfUpdateEmailCampaign(value: object): boolean {
|
|
209
|
+
let isInstance = true;
|
|
210
|
+
|
|
211
|
+
return isInstance;
|
|
212
|
+
}
|
|
213
|
+
|
|
214
|
+
export function UpdateEmailCampaignFromJSON(json: any): UpdateEmailCampaign {
|
|
215
|
+
return UpdateEmailCampaignFromJSONTyped(json, false);
|
|
216
|
+
}
|
|
217
|
+
|
|
218
|
+
export function UpdateEmailCampaignFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateEmailCampaign {
|
|
219
|
+
if (json === undefined || json === null) {
|
|
220
|
+
return json;
|
|
221
|
+
}
|
|
222
|
+
return {
|
|
223
|
+
tag: !exists(json, 'tag') ? undefined : json['tag'],
|
|
224
|
+
sender: !exists(json, 'sender') ? undefined : UpdateEmailCampaignSenderFromJSON(json['sender']),
|
|
225
|
+
name: !exists(json, 'name') ? undefined : json['name'],
|
|
226
|
+
htmlContent: !exists(json, 'htmlContent') ? undefined : json['htmlContent'],
|
|
227
|
+
htmlUrl: !exists(json, 'htmlUrl') ? undefined : json['htmlUrl'],
|
|
228
|
+
scheduledAt: !exists(json, 'scheduledAt') ? undefined : new Date(json['scheduledAt']),
|
|
229
|
+
subject: !exists(json, 'subject') ? undefined : json['subject'],
|
|
230
|
+
replyTo: !exists(json, 'replyTo') ? undefined : json['replyTo'],
|
|
231
|
+
toField: !exists(json, 'toField') ? undefined : json['toField'],
|
|
232
|
+
recipients: !exists(json, 'recipients') ? undefined : UpdateEmailCampaignRecipientsFromJSON(json['recipients']),
|
|
233
|
+
attachmentUrl: !exists(json, 'attachmentUrl') ? undefined : json['attachmentUrl'],
|
|
234
|
+
inlineImageActivation: !exists(json, 'inlineImageActivation') ? undefined : json['inlineImageActivation'],
|
|
235
|
+
mirrorActive: !exists(json, 'mirrorActive') ? undefined : json['mirrorActive'],
|
|
236
|
+
recurring: !exists(json, 'recurring') ? undefined : json['recurring'],
|
|
237
|
+
footer: !exists(json, 'footer') ? undefined : json['footer'],
|
|
238
|
+
header: !exists(json, 'header') ? undefined : json['header'],
|
|
239
|
+
utmCampaign: !exists(json, 'utmCampaign') ? undefined : json['utmCampaign'],
|
|
240
|
+
params: !exists(json, 'params') ? undefined : json['params'],
|
|
241
|
+
sendAtBestTime: !exists(json, 'sendAtBestTime') ? undefined : json['sendAtBestTime'],
|
|
242
|
+
abTesting: !exists(json, 'abTesting') ? undefined : json['abTesting'],
|
|
243
|
+
subjectA: !exists(json, 'subjectA') ? undefined : json['subjectA'],
|
|
244
|
+
subjectB: !exists(json, 'subjectB') ? undefined : json['subjectB'],
|
|
245
|
+
splitRule: !exists(json, 'splitRule') ? undefined : json['splitRule'],
|
|
246
|
+
winnerCriteria: !exists(json, 'winnerCriteria') ? undefined : json['winnerCriteria'],
|
|
247
|
+
winnerDelay: !exists(json, 'winnerDelay') ? undefined : json['winnerDelay'],
|
|
248
|
+
ipWarmupEnable: !exists(json, 'ipWarmupEnable') ? undefined : json['ipWarmupEnable'],
|
|
249
|
+
initialQuota: !exists(json, 'initialQuota') ? undefined : json['initialQuota'],
|
|
250
|
+
increaseRate: !exists(json, 'increaseRate') ? undefined : json['increaseRate'],
|
|
251
|
+
};
|
|
252
|
+
}
|
|
253
|
+
|
|
254
|
+
export function UpdateEmailCampaignToJSON(value?: UpdateEmailCampaign | null): any {
|
|
255
|
+
if (value === undefined) {
|
|
256
|
+
return undefined;
|
|
257
|
+
}
|
|
258
|
+
if (value === null) {
|
|
259
|
+
return null;
|
|
260
|
+
}
|
|
261
|
+
return {
|
|
262
|
+
tag: value.tag,
|
|
263
|
+
sender: UpdateEmailCampaignSenderToJSON(value.sender),
|
|
264
|
+
name: value.name,
|
|
265
|
+
htmlContent: value.htmlContent,
|
|
266
|
+
htmlUrl: value.htmlUrl,
|
|
267
|
+
scheduledAt: value.scheduledAt === undefined ? undefined : value.scheduledAt.toISOString(),
|
|
268
|
+
subject: value.subject,
|
|
269
|
+
replyTo: value.replyTo,
|
|
270
|
+
toField: value.toField,
|
|
271
|
+
recipients: UpdateEmailCampaignRecipientsToJSON(value.recipients),
|
|
272
|
+
attachmentUrl: value.attachmentUrl,
|
|
273
|
+
inlineImageActivation: value.inlineImageActivation,
|
|
274
|
+
mirrorActive: value.mirrorActive,
|
|
275
|
+
recurring: value.recurring,
|
|
276
|
+
footer: value.footer,
|
|
277
|
+
header: value.header,
|
|
278
|
+
utmCampaign: value.utmCampaign,
|
|
279
|
+
params: value.params,
|
|
280
|
+
sendAtBestTime: value.sendAtBestTime,
|
|
281
|
+
abTesting: value.abTesting,
|
|
282
|
+
subjectA: value.subjectA,
|
|
283
|
+
subjectB: value.subjectB,
|
|
284
|
+
splitRule: value.splitRule,
|
|
285
|
+
winnerCriteria: value.winnerCriteria,
|
|
286
|
+
winnerDelay: value.winnerDelay,
|
|
287
|
+
ipWarmupEnable: value.ipWarmupEnable,
|
|
288
|
+
initialQuota: value.initialQuota,
|
|
289
|
+
increaseRate: value.increaseRate,
|
|
290
|
+
};
|
|
291
|
+
}
|