@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,2295 @@
|
|
|
1
|
+
/* eslint-disable */
|
|
2
|
+
/**
|
|
3
|
+
* SendinBlue API
|
|
4
|
+
* SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
|
5
|
+
*
|
|
6
|
+
* The version of the OpenAPI document: 3.0.0
|
|
7
|
+
* Contact: contact@sendinblue.com
|
|
8
|
+
*
|
|
9
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
10
|
+
* https://openapi-generator.tech
|
|
11
|
+
* Do not edit the class manually.
|
|
12
|
+
*/
|
|
13
|
+
|
|
14
|
+
import * as runtime from '../runtime.js';
|
|
15
|
+
import type {
|
|
16
|
+
AddContactToList,
|
|
17
|
+
CreateAttribute,
|
|
18
|
+
CreateContact,
|
|
19
|
+
CreateDoiContact,
|
|
20
|
+
CreatedProcessId,
|
|
21
|
+
CreateList,
|
|
22
|
+
CreateModel,
|
|
23
|
+
CreateUpdateContactModel,
|
|
24
|
+
CreateUpdateFolder,
|
|
25
|
+
GetAttributes,
|
|
26
|
+
GetContactCampaignStats,
|
|
27
|
+
GetContacts,
|
|
28
|
+
GetExtendedContactDetails,
|
|
29
|
+
GetExtendedList,
|
|
30
|
+
GetFolder,
|
|
31
|
+
GetFolderLists,
|
|
32
|
+
GetFolders,
|
|
33
|
+
GetLists,
|
|
34
|
+
GetSegments,
|
|
35
|
+
PostContactInfo,
|
|
36
|
+
RemoveContactFromList,
|
|
37
|
+
RequestContactExport,
|
|
38
|
+
RequestContactImport,
|
|
39
|
+
UpdateAttribute,
|
|
40
|
+
UpdateContact,
|
|
41
|
+
UpdateList,
|
|
42
|
+
} from '../models/index.js';
|
|
43
|
+
import {
|
|
44
|
+
AddContactToListToJSON,
|
|
45
|
+
CreateAttributeToJSON,
|
|
46
|
+
CreateContactToJSON,
|
|
47
|
+
CreateDoiContactToJSON,
|
|
48
|
+
CreatedProcessIdFromJSON,
|
|
49
|
+
CreateListToJSON,
|
|
50
|
+
CreateModelFromJSON,
|
|
51
|
+
CreateUpdateContactModelFromJSON,
|
|
52
|
+
CreateUpdateFolderToJSON,
|
|
53
|
+
GetAttributesFromJSON,
|
|
54
|
+
GetContactCampaignStatsFromJSON,
|
|
55
|
+
GetContactsFromJSON,
|
|
56
|
+
GetExtendedContactDetailsFromJSON,
|
|
57
|
+
GetExtendedListFromJSON,
|
|
58
|
+
GetFolderFromJSON,
|
|
59
|
+
GetFolderListsFromJSON,
|
|
60
|
+
GetFoldersFromJSON,
|
|
61
|
+
GetListsFromJSON,
|
|
62
|
+
GetSegmentsFromJSON,
|
|
63
|
+
PostContactInfoFromJSON,
|
|
64
|
+
RemoveContactFromListToJSON,
|
|
65
|
+
RequestContactExportToJSON,
|
|
66
|
+
RequestContactImportToJSON,
|
|
67
|
+
UpdateAttributeToJSON,
|
|
68
|
+
UpdateContactToJSON,
|
|
69
|
+
UpdateListToJSON,
|
|
70
|
+
} from '../models/index.js';
|
|
71
|
+
|
|
72
|
+
export interface AddContactToListRequest {
|
|
73
|
+
listId: number;
|
|
74
|
+
contactEmails: AddContactToList;
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
export interface CreateAttributeRequest {
|
|
78
|
+
attributeCategory: CreateAttributeAttributeCategoryEnum;
|
|
79
|
+
attributeName: string;
|
|
80
|
+
createAttribute: CreateAttribute;
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
export interface CreateContactRequest {
|
|
84
|
+
createContact: CreateContact;
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
export interface CreateDoiContactRequest {
|
|
88
|
+
createDoiContact: CreateDoiContact;
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
export interface CreateFolderRequest {
|
|
92
|
+
createFolder: CreateUpdateFolder;
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
export interface CreateListRequest {
|
|
96
|
+
createList: CreateList;
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
export interface DeleteAttributeRequest {
|
|
100
|
+
attributeCategory: DeleteAttributeAttributeCategoryEnum;
|
|
101
|
+
attributeName: string;
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
export interface DeleteContactRequest {
|
|
105
|
+
email: string;
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
export interface DeleteFolderRequest {
|
|
109
|
+
folderId: number;
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
export interface DeleteListRequest {
|
|
113
|
+
listId: number;
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
export interface GetContactInfoRequest {
|
|
117
|
+
email: string;
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
export interface GetContactStatsRequest {
|
|
121
|
+
email: string;
|
|
122
|
+
startDate?: Date;
|
|
123
|
+
endDate?: Date;
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
export interface GetContactsRequest {
|
|
127
|
+
limit?: number;
|
|
128
|
+
offset?: number;
|
|
129
|
+
modifiedSince?: Date;
|
|
130
|
+
createdSince?: Date;
|
|
131
|
+
sort?: GetContactsSortEnum;
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
export interface GetContactsFromListRequest {
|
|
135
|
+
listId: number;
|
|
136
|
+
modifiedSince?: Date;
|
|
137
|
+
limit?: number;
|
|
138
|
+
offset?: number;
|
|
139
|
+
sort?: GetContactsFromListSortEnum;
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
export interface GetFolderRequest {
|
|
143
|
+
folderId: number;
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
export interface GetFolderListsRequest {
|
|
147
|
+
folderId: number;
|
|
148
|
+
limit?: number;
|
|
149
|
+
offset?: number;
|
|
150
|
+
sort?: GetFolderListsSortEnum;
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
export interface GetFoldersRequest {
|
|
154
|
+
limit: number;
|
|
155
|
+
offset: number;
|
|
156
|
+
sort?: GetFoldersSortEnum;
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
export interface GetListRequest {
|
|
160
|
+
listId: number;
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
export interface GetListsRequest {
|
|
164
|
+
limit?: number;
|
|
165
|
+
offset?: number;
|
|
166
|
+
sort?: GetListsSortEnum;
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
export interface GetSegmentsRequest {
|
|
170
|
+
limit: number;
|
|
171
|
+
offset: number;
|
|
172
|
+
sort?: GetSegmentsSortEnum;
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
export interface ImportContactsRequest {
|
|
176
|
+
requestContactImport: RequestContactImport;
|
|
177
|
+
}
|
|
178
|
+
|
|
179
|
+
export interface RemoveContactFromListRequest {
|
|
180
|
+
listId: number;
|
|
181
|
+
contactEmails: RemoveContactFromList;
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
export interface RequestContactExportRequest {
|
|
185
|
+
requestContactExport: RequestContactExport;
|
|
186
|
+
}
|
|
187
|
+
|
|
188
|
+
export interface UpdateAttributeRequest {
|
|
189
|
+
attributeCategory: UpdateAttributeAttributeCategoryEnum;
|
|
190
|
+
attributeName: string;
|
|
191
|
+
updateAttribute: UpdateAttribute;
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
export interface UpdateContactRequest {
|
|
195
|
+
email: string;
|
|
196
|
+
updateContact: UpdateContact;
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
export interface UpdateFolderRequest {
|
|
200
|
+
folderId: number;
|
|
201
|
+
updateFolder: CreateUpdateFolder;
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
export interface UpdateListRequest {
|
|
205
|
+
listId: number;
|
|
206
|
+
updateList: UpdateList;
|
|
207
|
+
}
|
|
208
|
+
|
|
209
|
+
/**
|
|
210
|
+
* ContactsApi - interface
|
|
211
|
+
*
|
|
212
|
+
* @export
|
|
213
|
+
* @interface ContactsApiInterface
|
|
214
|
+
*/
|
|
215
|
+
export interface ContactsApiInterface {
|
|
216
|
+
/**
|
|
217
|
+
*
|
|
218
|
+
* @summary Add existing contacts to a list
|
|
219
|
+
* @param {number} listId Id of the list
|
|
220
|
+
* @param {AddContactToList} contactEmails Emails addresses of the contacts
|
|
221
|
+
* @param {*} [options] Override http request option.
|
|
222
|
+
* @throws {RequiredError}
|
|
223
|
+
* @memberof ContactsApiInterface
|
|
224
|
+
*/
|
|
225
|
+
addContactToListRaw(
|
|
226
|
+
requestParameters: AddContactToListRequest,
|
|
227
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
228
|
+
): Promise<runtime.ApiResponse<PostContactInfo>>;
|
|
229
|
+
|
|
230
|
+
/**
|
|
231
|
+
* Add existing contacts to a list
|
|
232
|
+
*/
|
|
233
|
+
addContactToList(
|
|
234
|
+
requestParameters: AddContactToListRequest,
|
|
235
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
236
|
+
): Promise<PostContactInfo>;
|
|
237
|
+
|
|
238
|
+
/**
|
|
239
|
+
*
|
|
240
|
+
* @summary Create contact attribute
|
|
241
|
+
* @param {'normal' | 'transactional' | 'category' | 'calculated' | 'global'} attributeCategory Category of the attribute
|
|
242
|
+
* @param {string} attributeName Name of the attribute
|
|
243
|
+
* @param {CreateAttribute} createAttribute Values to create an attribute
|
|
244
|
+
* @param {*} [options] Override http request option.
|
|
245
|
+
* @throws {RequiredError}
|
|
246
|
+
* @memberof ContactsApiInterface
|
|
247
|
+
*/
|
|
248
|
+
createAttributeRaw(
|
|
249
|
+
requestParameters: CreateAttributeRequest,
|
|
250
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
251
|
+
): Promise<runtime.ApiResponse<void>>;
|
|
252
|
+
|
|
253
|
+
/**
|
|
254
|
+
* Create contact attribute
|
|
255
|
+
*/
|
|
256
|
+
createAttribute(requestParameters: CreateAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
257
|
+
|
|
258
|
+
/**
|
|
259
|
+
*
|
|
260
|
+
* @summary Create a contact
|
|
261
|
+
* @param {CreateContact} createContact Values to create a contact
|
|
262
|
+
* @param {*} [options] Override http request option.
|
|
263
|
+
* @throws {RequiredError}
|
|
264
|
+
* @memberof ContactsApiInterface
|
|
265
|
+
*/
|
|
266
|
+
createContactRaw(
|
|
267
|
+
requestParameters: CreateContactRequest,
|
|
268
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
269
|
+
): Promise<runtime.ApiResponse<CreateUpdateContactModel>>;
|
|
270
|
+
|
|
271
|
+
/**
|
|
272
|
+
* Create a contact
|
|
273
|
+
*/
|
|
274
|
+
createContact(
|
|
275
|
+
requestParameters: CreateContactRequest,
|
|
276
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
277
|
+
): Promise<CreateUpdateContactModel>;
|
|
278
|
+
|
|
279
|
+
/**
|
|
280
|
+
*
|
|
281
|
+
* @summary Create Contact via DOI (Double-Opt-In) Flow
|
|
282
|
+
* @param {CreateDoiContact} createDoiContact Values to create the Double opt-in (DOI) contact
|
|
283
|
+
* @param {*} [options] Override http request option.
|
|
284
|
+
* @throws {RequiredError}
|
|
285
|
+
* @memberof ContactsApiInterface
|
|
286
|
+
*/
|
|
287
|
+
createDoiContactRaw(
|
|
288
|
+
requestParameters: CreateDoiContactRequest,
|
|
289
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
290
|
+
): Promise<runtime.ApiResponse<void>>;
|
|
291
|
+
|
|
292
|
+
/**
|
|
293
|
+
* Create Contact via DOI (Double-Opt-In) Flow
|
|
294
|
+
*/
|
|
295
|
+
createDoiContact(requestParameters: CreateDoiContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
296
|
+
|
|
297
|
+
/**
|
|
298
|
+
*
|
|
299
|
+
* @summary Create a folder
|
|
300
|
+
* @param {CreateUpdateFolder} createFolder Name of the folder
|
|
301
|
+
* @param {*} [options] Override http request option.
|
|
302
|
+
* @throws {RequiredError}
|
|
303
|
+
* @memberof ContactsApiInterface
|
|
304
|
+
*/
|
|
305
|
+
createFolderRaw(
|
|
306
|
+
requestParameters: CreateFolderRequest,
|
|
307
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
308
|
+
): Promise<runtime.ApiResponse<CreateModel>>;
|
|
309
|
+
|
|
310
|
+
/**
|
|
311
|
+
* Create a folder
|
|
312
|
+
*/
|
|
313
|
+
createFolder(requestParameters: CreateFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateModel>;
|
|
314
|
+
|
|
315
|
+
/**
|
|
316
|
+
*
|
|
317
|
+
* @summary Create a list
|
|
318
|
+
* @param {CreateList} createList Values to create a list
|
|
319
|
+
* @param {*} [options] Override http request option.
|
|
320
|
+
* @throws {RequiredError}
|
|
321
|
+
* @memberof ContactsApiInterface
|
|
322
|
+
*/
|
|
323
|
+
createListRaw(
|
|
324
|
+
requestParameters: CreateListRequest,
|
|
325
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
326
|
+
): Promise<runtime.ApiResponse<CreateModel>>;
|
|
327
|
+
|
|
328
|
+
/**
|
|
329
|
+
* Create a list
|
|
330
|
+
*/
|
|
331
|
+
createList(requestParameters: CreateListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateModel>;
|
|
332
|
+
|
|
333
|
+
/**
|
|
334
|
+
*
|
|
335
|
+
* @summary Delete an attribute
|
|
336
|
+
* @param {'normal' | 'transactional' | 'category' | 'calculated' | 'global'} attributeCategory Category of the attribute
|
|
337
|
+
* @param {string} attributeName Name of the existing attribute
|
|
338
|
+
* @param {*} [options] Override http request option.
|
|
339
|
+
* @throws {RequiredError}
|
|
340
|
+
* @memberof ContactsApiInterface
|
|
341
|
+
*/
|
|
342
|
+
deleteAttributeRaw(
|
|
343
|
+
requestParameters: DeleteAttributeRequest,
|
|
344
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
345
|
+
): Promise<runtime.ApiResponse<void>>;
|
|
346
|
+
|
|
347
|
+
/**
|
|
348
|
+
* Delete an attribute
|
|
349
|
+
*/
|
|
350
|
+
deleteAttribute(requestParameters: DeleteAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
351
|
+
|
|
352
|
+
/**
|
|
353
|
+
*
|
|
354
|
+
* @summary Delete a contact
|
|
355
|
+
* @param {string} email Email (urlencoded) of the contact
|
|
356
|
+
* @param {*} [options] Override http request option.
|
|
357
|
+
* @throws {RequiredError}
|
|
358
|
+
* @memberof ContactsApiInterface
|
|
359
|
+
*/
|
|
360
|
+
deleteContactRaw(
|
|
361
|
+
requestParameters: DeleteContactRequest,
|
|
362
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
363
|
+
): Promise<runtime.ApiResponse<void>>;
|
|
364
|
+
|
|
365
|
+
/**
|
|
366
|
+
* Delete a contact
|
|
367
|
+
*/
|
|
368
|
+
deleteContact(requestParameters: DeleteContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
369
|
+
|
|
370
|
+
/**
|
|
371
|
+
*
|
|
372
|
+
* @summary Delete a folder (and all its lists)
|
|
373
|
+
* @param {number} folderId Id of the folder
|
|
374
|
+
* @param {*} [options] Override http request option.
|
|
375
|
+
* @throws {RequiredError}
|
|
376
|
+
* @memberof ContactsApiInterface
|
|
377
|
+
*/
|
|
378
|
+
deleteFolderRaw(
|
|
379
|
+
requestParameters: DeleteFolderRequest,
|
|
380
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
381
|
+
): Promise<runtime.ApiResponse<void>>;
|
|
382
|
+
|
|
383
|
+
/**
|
|
384
|
+
* Delete a folder (and all its lists)
|
|
385
|
+
*/
|
|
386
|
+
deleteFolder(requestParameters: DeleteFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
387
|
+
|
|
388
|
+
/**
|
|
389
|
+
*
|
|
390
|
+
* @summary Delete a list
|
|
391
|
+
* @param {number} listId Id of the list
|
|
392
|
+
* @param {*} [options] Override http request option.
|
|
393
|
+
* @throws {RequiredError}
|
|
394
|
+
* @memberof ContactsApiInterface
|
|
395
|
+
*/
|
|
396
|
+
deleteListRaw(
|
|
397
|
+
requestParameters: DeleteListRequest,
|
|
398
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
399
|
+
): Promise<runtime.ApiResponse<void>>;
|
|
400
|
+
|
|
401
|
+
/**
|
|
402
|
+
* Delete a list
|
|
403
|
+
*/
|
|
404
|
+
deleteList(requestParameters: DeleteListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
405
|
+
|
|
406
|
+
/**
|
|
407
|
+
*
|
|
408
|
+
* @summary List all attributes
|
|
409
|
+
* @param {*} [options] Override http request option.
|
|
410
|
+
* @throws {RequiredError}
|
|
411
|
+
* @memberof ContactsApiInterface
|
|
412
|
+
*/
|
|
413
|
+
getAttributesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAttributes>>;
|
|
414
|
+
|
|
415
|
+
/**
|
|
416
|
+
* List all attributes
|
|
417
|
+
*/
|
|
418
|
+
getAttributes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAttributes>;
|
|
419
|
+
|
|
420
|
+
/**
|
|
421
|
+
*
|
|
422
|
+
* @summary Get a contact\'s details
|
|
423
|
+
* @param {string} email Email (urlencoded) of the contact OR its SMS attribute value
|
|
424
|
+
* @param {*} [options] Override http request option.
|
|
425
|
+
* @throws {RequiredError}
|
|
426
|
+
* @memberof ContactsApiInterface
|
|
427
|
+
*/
|
|
428
|
+
getContactInfoRaw(
|
|
429
|
+
requestParameters: GetContactInfoRequest,
|
|
430
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
431
|
+
): Promise<runtime.ApiResponse<GetExtendedContactDetails>>;
|
|
432
|
+
|
|
433
|
+
/**
|
|
434
|
+
* Get a contact\'s details
|
|
435
|
+
*/
|
|
436
|
+
getContactInfo(
|
|
437
|
+
requestParameters: GetContactInfoRequest,
|
|
438
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
439
|
+
): Promise<GetExtendedContactDetails>;
|
|
440
|
+
|
|
441
|
+
/**
|
|
442
|
+
*
|
|
443
|
+
* @summary Get email campaigns\' statistics for a contact
|
|
444
|
+
* @param {string} email Email address (urlencoded) of the contact
|
|
445
|
+
* @param {Date} [startDate] Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
|
|
446
|
+
* @param {Date} [endDate] Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate
|
|
447
|
+
* @param {*} [options] Override http request option.
|
|
448
|
+
* @throws {RequiredError}
|
|
449
|
+
* @memberof ContactsApiInterface
|
|
450
|
+
*/
|
|
451
|
+
getContactStatsRaw(
|
|
452
|
+
requestParameters: GetContactStatsRequest,
|
|
453
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
454
|
+
): Promise<runtime.ApiResponse<GetContactCampaignStats>>;
|
|
455
|
+
|
|
456
|
+
/**
|
|
457
|
+
* Get email campaigns\' statistics for a contact
|
|
458
|
+
*/
|
|
459
|
+
getContactStats(
|
|
460
|
+
requestParameters: GetContactStatsRequest,
|
|
461
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
462
|
+
): Promise<GetContactCampaignStats>;
|
|
463
|
+
|
|
464
|
+
/**
|
|
465
|
+
*
|
|
466
|
+
* @summary Get all the contacts
|
|
467
|
+
* @param {number} [limit] Number of documents per page
|
|
468
|
+
* @param {number} [offset] Index of the first document of the page
|
|
469
|
+
* @param {Date} [modifiedSince] Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
|
470
|
+
* @param {Date} [createdSince] Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
|
471
|
+
* @param {'asc' | 'desc'} [sort] Sort the results in the ascending/descending order of record creation
|
|
472
|
+
* @param {*} [options] Override http request option.
|
|
473
|
+
* @throws {RequiredError}
|
|
474
|
+
* @memberof ContactsApiInterface
|
|
475
|
+
*/
|
|
476
|
+
getContactsRaw(
|
|
477
|
+
requestParameters: GetContactsRequest,
|
|
478
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
479
|
+
): Promise<runtime.ApiResponse<GetContacts>>;
|
|
480
|
+
|
|
481
|
+
/**
|
|
482
|
+
* Get all the contacts
|
|
483
|
+
*/
|
|
484
|
+
getContacts(requestParameters: GetContactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContacts>;
|
|
485
|
+
|
|
486
|
+
/**
|
|
487
|
+
*
|
|
488
|
+
* @summary Get contacts in a list
|
|
489
|
+
* @param {number} listId Id of the list
|
|
490
|
+
* @param {Date} [modifiedSince] Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
|
491
|
+
* @param {number} [limit] Number of documents per page
|
|
492
|
+
* @param {number} [offset] Index of the first document of the page
|
|
493
|
+
* @param {'asc' | 'desc'} [sort] Sort the results in the ascending/descending order of record creation
|
|
494
|
+
* @param {*} [options] Override http request option.
|
|
495
|
+
* @throws {RequiredError}
|
|
496
|
+
* @memberof ContactsApiInterface
|
|
497
|
+
*/
|
|
498
|
+
getContactsFromListRaw(
|
|
499
|
+
requestParameters: GetContactsFromListRequest,
|
|
500
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
501
|
+
): Promise<runtime.ApiResponse<GetContacts>>;
|
|
502
|
+
|
|
503
|
+
/**
|
|
504
|
+
* Get contacts in a list
|
|
505
|
+
*/
|
|
506
|
+
getContactsFromList(
|
|
507
|
+
requestParameters: GetContactsFromListRequest,
|
|
508
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
509
|
+
): Promise<GetContacts>;
|
|
510
|
+
|
|
511
|
+
/**
|
|
512
|
+
*
|
|
513
|
+
* @summary Returns a folder\'s details
|
|
514
|
+
* @param {number} folderId id of the folder
|
|
515
|
+
* @param {*} [options] Override http request option.
|
|
516
|
+
* @throws {RequiredError}
|
|
517
|
+
* @memberof ContactsApiInterface
|
|
518
|
+
*/
|
|
519
|
+
getFolderRaw(
|
|
520
|
+
requestParameters: GetFolderRequest,
|
|
521
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
522
|
+
): Promise<runtime.ApiResponse<GetFolder>>;
|
|
523
|
+
|
|
524
|
+
/**
|
|
525
|
+
* Returns a folder\'s details
|
|
526
|
+
*/
|
|
527
|
+
getFolder(requestParameters: GetFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetFolder>;
|
|
528
|
+
|
|
529
|
+
/**
|
|
530
|
+
*
|
|
531
|
+
* @summary Get lists in a folder
|
|
532
|
+
* @param {number} folderId Id of the folder
|
|
533
|
+
* @param {number} [limit] Number of documents per page
|
|
534
|
+
* @param {number} [offset] Index of the first document of the page
|
|
535
|
+
* @param {'asc' | 'desc'} [sort] Sort the results in the ascending/descending order of record creation
|
|
536
|
+
* @param {*} [options] Override http request option.
|
|
537
|
+
* @throws {RequiredError}
|
|
538
|
+
* @memberof ContactsApiInterface
|
|
539
|
+
*/
|
|
540
|
+
getFolderListsRaw(
|
|
541
|
+
requestParameters: GetFolderListsRequest,
|
|
542
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
543
|
+
): Promise<runtime.ApiResponse<GetFolderLists>>;
|
|
544
|
+
|
|
545
|
+
/**
|
|
546
|
+
* Get lists in a folder
|
|
547
|
+
*/
|
|
548
|
+
getFolderLists(
|
|
549
|
+
requestParameters: GetFolderListsRequest,
|
|
550
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
551
|
+
): Promise<GetFolderLists>;
|
|
552
|
+
|
|
553
|
+
/**
|
|
554
|
+
*
|
|
555
|
+
* @summary Get all folders
|
|
556
|
+
* @param {number} limit Number of documents per page
|
|
557
|
+
* @param {number} offset Index of the first document of the page
|
|
558
|
+
* @param {'asc' | 'desc'} [sort] Sort the results in the ascending/descending order of record creation
|
|
559
|
+
* @param {*} [options] Override http request option.
|
|
560
|
+
* @throws {RequiredError}
|
|
561
|
+
* @memberof ContactsApiInterface
|
|
562
|
+
*/
|
|
563
|
+
getFoldersRaw(
|
|
564
|
+
requestParameters: GetFoldersRequest,
|
|
565
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
566
|
+
): Promise<runtime.ApiResponse<GetFolders>>;
|
|
567
|
+
|
|
568
|
+
/**
|
|
569
|
+
* Get all folders
|
|
570
|
+
*/
|
|
571
|
+
getFolders(requestParameters: GetFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetFolders>;
|
|
572
|
+
|
|
573
|
+
/**
|
|
574
|
+
*
|
|
575
|
+
* @summary Get a list\'s details
|
|
576
|
+
* @param {number} listId Id of the list
|
|
577
|
+
* @param {*} [options] Override http request option.
|
|
578
|
+
* @throws {RequiredError}
|
|
579
|
+
* @memberof ContactsApiInterface
|
|
580
|
+
*/
|
|
581
|
+
getListRaw(
|
|
582
|
+
requestParameters: GetListRequest,
|
|
583
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
584
|
+
): Promise<runtime.ApiResponse<GetExtendedList>>;
|
|
585
|
+
|
|
586
|
+
/**
|
|
587
|
+
* Get a list\'s details
|
|
588
|
+
*/
|
|
589
|
+
getList(requestParameters: GetListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetExtendedList>;
|
|
590
|
+
|
|
591
|
+
/**
|
|
592
|
+
*
|
|
593
|
+
* @summary Get all the lists
|
|
594
|
+
* @param {number} [limit] Number of documents per page
|
|
595
|
+
* @param {number} [offset] Index of the first document of the page
|
|
596
|
+
* @param {'asc' | 'desc'} [sort] Sort the results in the ascending/descending order of record creation
|
|
597
|
+
* @param {*} [options] Override http request option.
|
|
598
|
+
* @throws {RequiredError}
|
|
599
|
+
* @memberof ContactsApiInterface
|
|
600
|
+
*/
|
|
601
|
+
getListsRaw(
|
|
602
|
+
requestParameters: GetListsRequest,
|
|
603
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
604
|
+
): Promise<runtime.ApiResponse<GetLists>>;
|
|
605
|
+
|
|
606
|
+
/**
|
|
607
|
+
* Get all the lists
|
|
608
|
+
*/
|
|
609
|
+
getLists(requestParameters: GetListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLists>;
|
|
610
|
+
|
|
611
|
+
/**
|
|
612
|
+
*
|
|
613
|
+
* @summary Get all the segments
|
|
614
|
+
* @param {number} limit Number of documents per page
|
|
615
|
+
* @param {number} offset Index of the first document of the page
|
|
616
|
+
* @param {'asc' | 'desc'} [sort] Sort the results in the ascending/descending order of record creation
|
|
617
|
+
* @param {*} [options] Override http request option.
|
|
618
|
+
* @throws {RequiredError}
|
|
619
|
+
* @memberof ContactsApiInterface
|
|
620
|
+
*/
|
|
621
|
+
getSegmentsRaw(
|
|
622
|
+
requestParameters: GetSegmentsRequest,
|
|
623
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
624
|
+
): Promise<runtime.ApiResponse<GetSegments>>;
|
|
625
|
+
|
|
626
|
+
/**
|
|
627
|
+
* Get all the segments
|
|
628
|
+
*/
|
|
629
|
+
getSegments(requestParameters: GetSegmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSegments>;
|
|
630
|
+
|
|
631
|
+
/**
|
|
632
|
+
* It returns the background process ID which on completion calls the notify URL that you have set in the input.
|
|
633
|
+
* @summary Import contacts
|
|
634
|
+
* @param {RequestContactImport} requestContactImport Values to import contacts in Sendinblue. To know more about the expected format, please have a look at ``https://help.sendinblue.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns``
|
|
635
|
+
* @param {*} [options] Override http request option.
|
|
636
|
+
* @throws {RequiredError}
|
|
637
|
+
* @memberof ContactsApiInterface
|
|
638
|
+
*/
|
|
639
|
+
importContactsRaw(
|
|
640
|
+
requestParameters: ImportContactsRequest,
|
|
641
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
642
|
+
): Promise<runtime.ApiResponse<CreatedProcessId>>;
|
|
643
|
+
|
|
644
|
+
/**
|
|
645
|
+
* It returns the background process ID which on completion calls the notify URL that you have set in the input.
|
|
646
|
+
* Import contacts
|
|
647
|
+
*/
|
|
648
|
+
importContacts(
|
|
649
|
+
requestParameters: ImportContactsRequest,
|
|
650
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
651
|
+
): Promise<CreatedProcessId>;
|
|
652
|
+
|
|
653
|
+
/**
|
|
654
|
+
*
|
|
655
|
+
* @summary Delete a contact from a list
|
|
656
|
+
* @param {number} listId Id of the list
|
|
657
|
+
* @param {RemoveContactFromList} contactEmails Emails adresses of the contact
|
|
658
|
+
* @param {*} [options] Override http request option.
|
|
659
|
+
* @throws {RequiredError}
|
|
660
|
+
* @memberof ContactsApiInterface
|
|
661
|
+
*/
|
|
662
|
+
removeContactFromListRaw(
|
|
663
|
+
requestParameters: RemoveContactFromListRequest,
|
|
664
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
665
|
+
): Promise<runtime.ApiResponse<PostContactInfo>>;
|
|
666
|
+
|
|
667
|
+
/**
|
|
668
|
+
* Delete a contact from a list
|
|
669
|
+
*/
|
|
670
|
+
removeContactFromList(
|
|
671
|
+
requestParameters: RemoveContactFromListRequest,
|
|
672
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
673
|
+
): Promise<PostContactInfo>;
|
|
674
|
+
|
|
675
|
+
/**
|
|
676
|
+
* It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv.
|
|
677
|
+
* @summary Export contacts
|
|
678
|
+
* @param {RequestContactExport} requestContactExport Values to request a contact export
|
|
679
|
+
* @param {*} [options] Override http request option.
|
|
680
|
+
* @throws {RequiredError}
|
|
681
|
+
* @memberof ContactsApiInterface
|
|
682
|
+
*/
|
|
683
|
+
requestContactExportRaw(
|
|
684
|
+
requestParameters: RequestContactExportRequest,
|
|
685
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
686
|
+
): Promise<runtime.ApiResponse<CreatedProcessId>>;
|
|
687
|
+
|
|
688
|
+
/**
|
|
689
|
+
* It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv.
|
|
690
|
+
* Export contacts
|
|
691
|
+
*/
|
|
692
|
+
requestContactExport(
|
|
693
|
+
requestParameters: RequestContactExportRequest,
|
|
694
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
695
|
+
): Promise<CreatedProcessId>;
|
|
696
|
+
|
|
697
|
+
/**
|
|
698
|
+
*
|
|
699
|
+
* @summary Update contact attribute
|
|
700
|
+
* @param {'category' | 'calculated' | 'global'} attributeCategory Category of the attribute
|
|
701
|
+
* @param {string} attributeName Name of the existing attribute
|
|
702
|
+
* @param {UpdateAttribute} updateAttribute Values to update an attribute
|
|
703
|
+
* @param {*} [options] Override http request option.
|
|
704
|
+
* @throws {RequiredError}
|
|
705
|
+
* @memberof ContactsApiInterface
|
|
706
|
+
*/
|
|
707
|
+
updateAttributeRaw(
|
|
708
|
+
requestParameters: UpdateAttributeRequest,
|
|
709
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
710
|
+
): Promise<runtime.ApiResponse<void>>;
|
|
711
|
+
|
|
712
|
+
/**
|
|
713
|
+
* Update contact attribute
|
|
714
|
+
*/
|
|
715
|
+
updateAttribute(requestParameters: UpdateAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
716
|
+
|
|
717
|
+
/**
|
|
718
|
+
*
|
|
719
|
+
* @summary Update a contact
|
|
720
|
+
* @param {string} email Email (urlencoded) of the contact
|
|
721
|
+
* @param {UpdateContact} updateContact Values to update a contact
|
|
722
|
+
* @param {*} [options] Override http request option.
|
|
723
|
+
* @throws {RequiredError}
|
|
724
|
+
* @memberof ContactsApiInterface
|
|
725
|
+
*/
|
|
726
|
+
updateContactRaw(
|
|
727
|
+
requestParameters: UpdateContactRequest,
|
|
728
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
729
|
+
): Promise<runtime.ApiResponse<void>>;
|
|
730
|
+
|
|
731
|
+
/**
|
|
732
|
+
* Update a contact
|
|
733
|
+
*/
|
|
734
|
+
updateContact(requestParameters: UpdateContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
735
|
+
|
|
736
|
+
/**
|
|
737
|
+
*
|
|
738
|
+
* @summary Update a folder
|
|
739
|
+
* @param {number} folderId Id of the folder
|
|
740
|
+
* @param {CreateUpdateFolder} updateFolder Name of the folder
|
|
741
|
+
* @param {*} [options] Override http request option.
|
|
742
|
+
* @throws {RequiredError}
|
|
743
|
+
* @memberof ContactsApiInterface
|
|
744
|
+
*/
|
|
745
|
+
updateFolderRaw(
|
|
746
|
+
requestParameters: UpdateFolderRequest,
|
|
747
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
748
|
+
): Promise<runtime.ApiResponse<void>>;
|
|
749
|
+
|
|
750
|
+
/**
|
|
751
|
+
* Update a folder
|
|
752
|
+
*/
|
|
753
|
+
updateFolder(requestParameters: UpdateFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
754
|
+
|
|
755
|
+
/**
|
|
756
|
+
*
|
|
757
|
+
* @summary Update a list
|
|
758
|
+
* @param {number} listId Id of the list
|
|
759
|
+
* @param {UpdateList} updateList Values to update a list
|
|
760
|
+
* @param {*} [options] Override http request option.
|
|
761
|
+
* @throws {RequiredError}
|
|
762
|
+
* @memberof ContactsApiInterface
|
|
763
|
+
*/
|
|
764
|
+
updateListRaw(
|
|
765
|
+
requestParameters: UpdateListRequest,
|
|
766
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
767
|
+
): Promise<runtime.ApiResponse<void>>;
|
|
768
|
+
|
|
769
|
+
/**
|
|
770
|
+
* Update a list
|
|
771
|
+
*/
|
|
772
|
+
updateList(requestParameters: UpdateListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
773
|
+
}
|
|
774
|
+
|
|
775
|
+
/**
|
|
776
|
+
*
|
|
777
|
+
*/
|
|
778
|
+
export class ContactsApi extends runtime.BaseAPI implements ContactsApiInterface {
|
|
779
|
+
/**
|
|
780
|
+
* Add existing contacts to a list
|
|
781
|
+
*/
|
|
782
|
+
async addContactToListRaw(
|
|
783
|
+
requestParameters: AddContactToListRequest,
|
|
784
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
785
|
+
): Promise<runtime.ApiResponse<PostContactInfo>> {
|
|
786
|
+
if (requestParameters.listId === null || requestParameters.listId === undefined) {
|
|
787
|
+
throw new runtime.RequiredError(
|
|
788
|
+
'listId',
|
|
789
|
+
'Required parameter requestParameters.listId was null or undefined when calling addContactToList.',
|
|
790
|
+
);
|
|
791
|
+
}
|
|
792
|
+
|
|
793
|
+
if (requestParameters.contactEmails === null || requestParameters.contactEmails === undefined) {
|
|
794
|
+
throw new runtime.RequiredError(
|
|
795
|
+
'contactEmails',
|
|
796
|
+
'Required parameter requestParameters.contactEmails was null or undefined when calling addContactToList.',
|
|
797
|
+
);
|
|
798
|
+
}
|
|
799
|
+
|
|
800
|
+
const queryParameters: any = {};
|
|
801
|
+
|
|
802
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
803
|
+
|
|
804
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
805
|
+
|
|
806
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
807
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
808
|
+
}
|
|
809
|
+
|
|
810
|
+
const response = await this.request(
|
|
811
|
+
{
|
|
812
|
+
path: `/contacts/lists/{listId}/contacts/add`.replace(`{${'listId'}}`, encodeURIComponent(String(requestParameters.listId))),
|
|
813
|
+
method: 'POST',
|
|
814
|
+
headers: headerParameters,
|
|
815
|
+
query: queryParameters,
|
|
816
|
+
body: AddContactToListToJSON(requestParameters.contactEmails),
|
|
817
|
+
},
|
|
818
|
+
initOverrides,
|
|
819
|
+
);
|
|
820
|
+
|
|
821
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => PostContactInfoFromJSON(jsonValue));
|
|
822
|
+
}
|
|
823
|
+
|
|
824
|
+
/**
|
|
825
|
+
* Add existing contacts to a list
|
|
826
|
+
*/
|
|
827
|
+
async addContactToList(
|
|
828
|
+
requestParameters: AddContactToListRequest,
|
|
829
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
830
|
+
): Promise<PostContactInfo> {
|
|
831
|
+
const response = await this.addContactToListRaw(requestParameters, initOverrides);
|
|
832
|
+
return await response.value();
|
|
833
|
+
}
|
|
834
|
+
|
|
835
|
+
/**
|
|
836
|
+
* Create contact attribute
|
|
837
|
+
*/
|
|
838
|
+
async createAttributeRaw(
|
|
839
|
+
requestParameters: CreateAttributeRequest,
|
|
840
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
841
|
+
): Promise<runtime.ApiResponse<void>> {
|
|
842
|
+
if (requestParameters.attributeCategory === null || requestParameters.attributeCategory === undefined) {
|
|
843
|
+
throw new runtime.RequiredError(
|
|
844
|
+
'attributeCategory',
|
|
845
|
+
'Required parameter requestParameters.attributeCategory was null or undefined when calling createAttribute.',
|
|
846
|
+
);
|
|
847
|
+
}
|
|
848
|
+
|
|
849
|
+
if (requestParameters.attributeName === null || requestParameters.attributeName === undefined) {
|
|
850
|
+
throw new runtime.RequiredError(
|
|
851
|
+
'attributeName',
|
|
852
|
+
'Required parameter requestParameters.attributeName was null or undefined when calling createAttribute.',
|
|
853
|
+
);
|
|
854
|
+
}
|
|
855
|
+
|
|
856
|
+
if (requestParameters.createAttribute === null || requestParameters.createAttribute === undefined) {
|
|
857
|
+
throw new runtime.RequiredError(
|
|
858
|
+
'createAttribute',
|
|
859
|
+
'Required parameter requestParameters.createAttribute was null or undefined when calling createAttribute.',
|
|
860
|
+
);
|
|
861
|
+
}
|
|
862
|
+
|
|
863
|
+
const queryParameters: any = {};
|
|
864
|
+
|
|
865
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
866
|
+
|
|
867
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
868
|
+
|
|
869
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
870
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
871
|
+
}
|
|
872
|
+
|
|
873
|
+
const response = await this.request(
|
|
874
|
+
{
|
|
875
|
+
path: `/contacts/attributes/{attributeCategory}/{attributeName}`
|
|
876
|
+
.replace(`{${'attributeCategory'}}`, encodeURIComponent(String(requestParameters.attributeCategory)))
|
|
877
|
+
.replace(`{${'attributeName'}}`, encodeURIComponent(String(requestParameters.attributeName))),
|
|
878
|
+
method: 'POST',
|
|
879
|
+
headers: headerParameters,
|
|
880
|
+
query: queryParameters,
|
|
881
|
+
body: CreateAttributeToJSON(requestParameters.createAttribute),
|
|
882
|
+
},
|
|
883
|
+
initOverrides,
|
|
884
|
+
);
|
|
885
|
+
|
|
886
|
+
return new runtime.VoidApiResponse(response);
|
|
887
|
+
}
|
|
888
|
+
|
|
889
|
+
/**
|
|
890
|
+
* Create contact attribute
|
|
891
|
+
*/
|
|
892
|
+
async createAttribute(
|
|
893
|
+
requestParameters: CreateAttributeRequest,
|
|
894
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
895
|
+
): Promise<void> {
|
|
896
|
+
await this.createAttributeRaw(requestParameters, initOverrides);
|
|
897
|
+
}
|
|
898
|
+
|
|
899
|
+
/**
|
|
900
|
+
* Create a contact
|
|
901
|
+
*/
|
|
902
|
+
async createContactRaw(
|
|
903
|
+
requestParameters: CreateContactRequest,
|
|
904
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
905
|
+
): Promise<runtime.ApiResponse<CreateUpdateContactModel>> {
|
|
906
|
+
if (requestParameters.createContact === null || requestParameters.createContact === undefined) {
|
|
907
|
+
throw new runtime.RequiredError(
|
|
908
|
+
'createContact',
|
|
909
|
+
'Required parameter requestParameters.createContact was null or undefined when calling createContact.',
|
|
910
|
+
);
|
|
911
|
+
}
|
|
912
|
+
|
|
913
|
+
const queryParameters: any = {};
|
|
914
|
+
|
|
915
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
916
|
+
|
|
917
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
918
|
+
|
|
919
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
920
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
921
|
+
}
|
|
922
|
+
|
|
923
|
+
const response = await this.request(
|
|
924
|
+
{
|
|
925
|
+
path: `/contacts`,
|
|
926
|
+
method: 'POST',
|
|
927
|
+
headers: headerParameters,
|
|
928
|
+
query: queryParameters,
|
|
929
|
+
body: CreateContactToJSON(requestParameters.createContact),
|
|
930
|
+
},
|
|
931
|
+
initOverrides,
|
|
932
|
+
);
|
|
933
|
+
|
|
934
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CreateUpdateContactModelFromJSON(jsonValue));
|
|
935
|
+
}
|
|
936
|
+
|
|
937
|
+
/**
|
|
938
|
+
* Create a contact
|
|
939
|
+
*/
|
|
940
|
+
async createContact(
|
|
941
|
+
requestParameters: CreateContactRequest,
|
|
942
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
943
|
+
): Promise<CreateUpdateContactModel> {
|
|
944
|
+
const response = await this.createContactRaw(requestParameters, initOverrides);
|
|
945
|
+
return await response.value();
|
|
946
|
+
}
|
|
947
|
+
|
|
948
|
+
/**
|
|
949
|
+
* Create Contact via DOI (Double-Opt-In) Flow
|
|
950
|
+
*/
|
|
951
|
+
async createDoiContactRaw(
|
|
952
|
+
requestParameters: CreateDoiContactRequest,
|
|
953
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
954
|
+
): Promise<runtime.ApiResponse<void>> {
|
|
955
|
+
if (requestParameters.createDoiContact === null || requestParameters.createDoiContact === undefined) {
|
|
956
|
+
throw new runtime.RequiredError(
|
|
957
|
+
'createDoiContact',
|
|
958
|
+
'Required parameter requestParameters.createDoiContact was null or undefined when calling createDoiContact.',
|
|
959
|
+
);
|
|
960
|
+
}
|
|
961
|
+
|
|
962
|
+
const queryParameters: any = {};
|
|
963
|
+
|
|
964
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
965
|
+
|
|
966
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
967
|
+
|
|
968
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
969
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
970
|
+
}
|
|
971
|
+
|
|
972
|
+
const response = await this.request(
|
|
973
|
+
{
|
|
974
|
+
path: `/contacts/doubleOptinConfirmation`,
|
|
975
|
+
method: 'POST',
|
|
976
|
+
headers: headerParameters,
|
|
977
|
+
query: queryParameters,
|
|
978
|
+
body: CreateDoiContactToJSON(requestParameters.createDoiContact),
|
|
979
|
+
},
|
|
980
|
+
initOverrides,
|
|
981
|
+
);
|
|
982
|
+
|
|
983
|
+
return new runtime.VoidApiResponse(response);
|
|
984
|
+
}
|
|
985
|
+
|
|
986
|
+
/**
|
|
987
|
+
* Create Contact via DOI (Double-Opt-In) Flow
|
|
988
|
+
*/
|
|
989
|
+
async createDoiContact(
|
|
990
|
+
requestParameters: CreateDoiContactRequest,
|
|
991
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
992
|
+
): Promise<void> {
|
|
993
|
+
await this.createDoiContactRaw(requestParameters, initOverrides);
|
|
994
|
+
}
|
|
995
|
+
|
|
996
|
+
/**
|
|
997
|
+
* Create a folder
|
|
998
|
+
*/
|
|
999
|
+
async createFolderRaw(
|
|
1000
|
+
requestParameters: CreateFolderRequest,
|
|
1001
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1002
|
+
): Promise<runtime.ApiResponse<CreateModel>> {
|
|
1003
|
+
if (requestParameters.createFolder === null || requestParameters.createFolder === undefined) {
|
|
1004
|
+
throw new runtime.RequiredError(
|
|
1005
|
+
'createFolder',
|
|
1006
|
+
'Required parameter requestParameters.createFolder was null or undefined when calling createFolder.',
|
|
1007
|
+
);
|
|
1008
|
+
}
|
|
1009
|
+
|
|
1010
|
+
const queryParameters: any = {};
|
|
1011
|
+
|
|
1012
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1013
|
+
|
|
1014
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1015
|
+
|
|
1016
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1017
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1018
|
+
}
|
|
1019
|
+
|
|
1020
|
+
const response = await this.request(
|
|
1021
|
+
{
|
|
1022
|
+
path: `/contacts/folders`,
|
|
1023
|
+
method: 'POST',
|
|
1024
|
+
headers: headerParameters,
|
|
1025
|
+
query: queryParameters,
|
|
1026
|
+
body: CreateUpdateFolderToJSON(requestParameters.createFolder),
|
|
1027
|
+
},
|
|
1028
|
+
initOverrides,
|
|
1029
|
+
);
|
|
1030
|
+
|
|
1031
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CreateModelFromJSON(jsonValue));
|
|
1032
|
+
}
|
|
1033
|
+
|
|
1034
|
+
/**
|
|
1035
|
+
* Create a folder
|
|
1036
|
+
*/
|
|
1037
|
+
async createFolder(
|
|
1038
|
+
requestParameters: CreateFolderRequest,
|
|
1039
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1040
|
+
): Promise<CreateModel> {
|
|
1041
|
+
const response = await this.createFolderRaw(requestParameters, initOverrides);
|
|
1042
|
+
return await response.value();
|
|
1043
|
+
}
|
|
1044
|
+
|
|
1045
|
+
/**
|
|
1046
|
+
* Create a list
|
|
1047
|
+
*/
|
|
1048
|
+
async createListRaw(
|
|
1049
|
+
requestParameters: CreateListRequest,
|
|
1050
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1051
|
+
): Promise<runtime.ApiResponse<CreateModel>> {
|
|
1052
|
+
if (requestParameters.createList === null || requestParameters.createList === undefined) {
|
|
1053
|
+
throw new runtime.RequiredError(
|
|
1054
|
+
'createList',
|
|
1055
|
+
'Required parameter requestParameters.createList was null or undefined when calling createList.',
|
|
1056
|
+
);
|
|
1057
|
+
}
|
|
1058
|
+
|
|
1059
|
+
const queryParameters: any = {};
|
|
1060
|
+
|
|
1061
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1062
|
+
|
|
1063
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1064
|
+
|
|
1065
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1066
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1067
|
+
}
|
|
1068
|
+
|
|
1069
|
+
const response = await this.request(
|
|
1070
|
+
{
|
|
1071
|
+
path: `/contacts/lists`,
|
|
1072
|
+
method: 'POST',
|
|
1073
|
+
headers: headerParameters,
|
|
1074
|
+
query: queryParameters,
|
|
1075
|
+
body: CreateListToJSON(requestParameters.createList),
|
|
1076
|
+
},
|
|
1077
|
+
initOverrides,
|
|
1078
|
+
);
|
|
1079
|
+
|
|
1080
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CreateModelFromJSON(jsonValue));
|
|
1081
|
+
}
|
|
1082
|
+
|
|
1083
|
+
/**
|
|
1084
|
+
* Create a list
|
|
1085
|
+
*/
|
|
1086
|
+
async createList(requestParameters: CreateListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateModel> {
|
|
1087
|
+
const response = await this.createListRaw(requestParameters, initOverrides);
|
|
1088
|
+
return await response.value();
|
|
1089
|
+
}
|
|
1090
|
+
|
|
1091
|
+
/**
|
|
1092
|
+
* Delete an attribute
|
|
1093
|
+
*/
|
|
1094
|
+
async deleteAttributeRaw(
|
|
1095
|
+
requestParameters: DeleteAttributeRequest,
|
|
1096
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1097
|
+
): Promise<runtime.ApiResponse<void>> {
|
|
1098
|
+
if (requestParameters.attributeCategory === null || requestParameters.attributeCategory === undefined) {
|
|
1099
|
+
throw new runtime.RequiredError(
|
|
1100
|
+
'attributeCategory',
|
|
1101
|
+
'Required parameter requestParameters.attributeCategory was null or undefined when calling deleteAttribute.',
|
|
1102
|
+
);
|
|
1103
|
+
}
|
|
1104
|
+
|
|
1105
|
+
if (requestParameters.attributeName === null || requestParameters.attributeName === undefined) {
|
|
1106
|
+
throw new runtime.RequiredError(
|
|
1107
|
+
'attributeName',
|
|
1108
|
+
'Required parameter requestParameters.attributeName was null or undefined when calling deleteAttribute.',
|
|
1109
|
+
);
|
|
1110
|
+
}
|
|
1111
|
+
|
|
1112
|
+
const queryParameters: any = {};
|
|
1113
|
+
|
|
1114
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1115
|
+
|
|
1116
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1117
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1118
|
+
}
|
|
1119
|
+
|
|
1120
|
+
const response = await this.request(
|
|
1121
|
+
{
|
|
1122
|
+
path: `/contacts/attributes/{attributeCategory}/{attributeName}`
|
|
1123
|
+
.replace(`{${'attributeCategory'}}`, encodeURIComponent(String(requestParameters.attributeCategory)))
|
|
1124
|
+
.replace(`{${'attributeName'}}`, encodeURIComponent(String(requestParameters.attributeName))),
|
|
1125
|
+
method: 'DELETE',
|
|
1126
|
+
headers: headerParameters,
|
|
1127
|
+
query: queryParameters,
|
|
1128
|
+
},
|
|
1129
|
+
initOverrides,
|
|
1130
|
+
);
|
|
1131
|
+
|
|
1132
|
+
return new runtime.VoidApiResponse(response);
|
|
1133
|
+
}
|
|
1134
|
+
|
|
1135
|
+
/**
|
|
1136
|
+
* Delete an attribute
|
|
1137
|
+
*/
|
|
1138
|
+
async deleteAttribute(
|
|
1139
|
+
requestParameters: DeleteAttributeRequest,
|
|
1140
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1141
|
+
): Promise<void> {
|
|
1142
|
+
await this.deleteAttributeRaw(requestParameters, initOverrides);
|
|
1143
|
+
}
|
|
1144
|
+
|
|
1145
|
+
/**
|
|
1146
|
+
* Delete a contact
|
|
1147
|
+
*/
|
|
1148
|
+
async deleteContactRaw(
|
|
1149
|
+
requestParameters: DeleteContactRequest,
|
|
1150
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1151
|
+
): Promise<runtime.ApiResponse<void>> {
|
|
1152
|
+
if (requestParameters.email === null || requestParameters.email === undefined) {
|
|
1153
|
+
throw new runtime.RequiredError(
|
|
1154
|
+
'email',
|
|
1155
|
+
'Required parameter requestParameters.email was null or undefined when calling deleteContact.',
|
|
1156
|
+
);
|
|
1157
|
+
}
|
|
1158
|
+
|
|
1159
|
+
const queryParameters: any = {};
|
|
1160
|
+
|
|
1161
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1162
|
+
|
|
1163
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1164
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1165
|
+
}
|
|
1166
|
+
|
|
1167
|
+
const response = await this.request(
|
|
1168
|
+
{
|
|
1169
|
+
path: `/contacts/{email}`.replace(`{${'email'}}`, encodeURIComponent(String(requestParameters.email))),
|
|
1170
|
+
method: 'DELETE',
|
|
1171
|
+
headers: headerParameters,
|
|
1172
|
+
query: queryParameters,
|
|
1173
|
+
},
|
|
1174
|
+
initOverrides,
|
|
1175
|
+
);
|
|
1176
|
+
|
|
1177
|
+
return new runtime.VoidApiResponse(response);
|
|
1178
|
+
}
|
|
1179
|
+
|
|
1180
|
+
/**
|
|
1181
|
+
* Delete a contact
|
|
1182
|
+
*/
|
|
1183
|
+
async deleteContact(requestParameters: DeleteContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
1184
|
+
await this.deleteContactRaw(requestParameters, initOverrides);
|
|
1185
|
+
}
|
|
1186
|
+
|
|
1187
|
+
/**
|
|
1188
|
+
* Delete a folder (and all its lists)
|
|
1189
|
+
*/
|
|
1190
|
+
async deleteFolderRaw(
|
|
1191
|
+
requestParameters: DeleteFolderRequest,
|
|
1192
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1193
|
+
): Promise<runtime.ApiResponse<void>> {
|
|
1194
|
+
if (requestParameters.folderId === null || requestParameters.folderId === undefined) {
|
|
1195
|
+
throw new runtime.RequiredError(
|
|
1196
|
+
'folderId',
|
|
1197
|
+
'Required parameter requestParameters.folderId was null or undefined when calling deleteFolder.',
|
|
1198
|
+
);
|
|
1199
|
+
}
|
|
1200
|
+
|
|
1201
|
+
const queryParameters: any = {};
|
|
1202
|
+
|
|
1203
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1204
|
+
|
|
1205
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1206
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1207
|
+
}
|
|
1208
|
+
|
|
1209
|
+
const response = await this.request(
|
|
1210
|
+
{
|
|
1211
|
+
path: `/contacts/folders/{folderId}`.replace(`{${'folderId'}}`, encodeURIComponent(String(requestParameters.folderId))),
|
|
1212
|
+
method: 'DELETE',
|
|
1213
|
+
headers: headerParameters,
|
|
1214
|
+
query: queryParameters,
|
|
1215
|
+
},
|
|
1216
|
+
initOverrides,
|
|
1217
|
+
);
|
|
1218
|
+
|
|
1219
|
+
return new runtime.VoidApiResponse(response);
|
|
1220
|
+
}
|
|
1221
|
+
|
|
1222
|
+
/**
|
|
1223
|
+
* Delete a folder (and all its lists)
|
|
1224
|
+
*/
|
|
1225
|
+
async deleteFolder(requestParameters: DeleteFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
1226
|
+
await this.deleteFolderRaw(requestParameters, initOverrides);
|
|
1227
|
+
}
|
|
1228
|
+
|
|
1229
|
+
/**
|
|
1230
|
+
* Delete a list
|
|
1231
|
+
*/
|
|
1232
|
+
async deleteListRaw(
|
|
1233
|
+
requestParameters: DeleteListRequest,
|
|
1234
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1235
|
+
): Promise<runtime.ApiResponse<void>> {
|
|
1236
|
+
if (requestParameters.listId === null || requestParameters.listId === undefined) {
|
|
1237
|
+
throw new runtime.RequiredError(
|
|
1238
|
+
'listId',
|
|
1239
|
+
'Required parameter requestParameters.listId was null or undefined when calling deleteList.',
|
|
1240
|
+
);
|
|
1241
|
+
}
|
|
1242
|
+
|
|
1243
|
+
const queryParameters: any = {};
|
|
1244
|
+
|
|
1245
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1246
|
+
|
|
1247
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1248
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1249
|
+
}
|
|
1250
|
+
|
|
1251
|
+
const response = await this.request(
|
|
1252
|
+
{
|
|
1253
|
+
path: `/contacts/lists/{listId}`.replace(`{${'listId'}}`, encodeURIComponent(String(requestParameters.listId))),
|
|
1254
|
+
method: 'DELETE',
|
|
1255
|
+
headers: headerParameters,
|
|
1256
|
+
query: queryParameters,
|
|
1257
|
+
},
|
|
1258
|
+
initOverrides,
|
|
1259
|
+
);
|
|
1260
|
+
|
|
1261
|
+
return new runtime.VoidApiResponse(response);
|
|
1262
|
+
}
|
|
1263
|
+
|
|
1264
|
+
/**
|
|
1265
|
+
* Delete a list
|
|
1266
|
+
*/
|
|
1267
|
+
async deleteList(requestParameters: DeleteListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
1268
|
+
await this.deleteListRaw(requestParameters, initOverrides);
|
|
1269
|
+
}
|
|
1270
|
+
|
|
1271
|
+
/**
|
|
1272
|
+
* List all attributes
|
|
1273
|
+
*/
|
|
1274
|
+
async getAttributesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAttributes>> {
|
|
1275
|
+
const queryParameters: any = {};
|
|
1276
|
+
|
|
1277
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1278
|
+
|
|
1279
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1280
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1281
|
+
}
|
|
1282
|
+
|
|
1283
|
+
const response = await this.request(
|
|
1284
|
+
{
|
|
1285
|
+
path: `/contacts/attributes`,
|
|
1286
|
+
method: 'GET',
|
|
1287
|
+
headers: headerParameters,
|
|
1288
|
+
query: queryParameters,
|
|
1289
|
+
},
|
|
1290
|
+
initOverrides,
|
|
1291
|
+
);
|
|
1292
|
+
|
|
1293
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetAttributesFromJSON(jsonValue));
|
|
1294
|
+
}
|
|
1295
|
+
|
|
1296
|
+
/**
|
|
1297
|
+
* List all attributes
|
|
1298
|
+
*/
|
|
1299
|
+
async getAttributes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAttributes> {
|
|
1300
|
+
const response = await this.getAttributesRaw(initOverrides);
|
|
1301
|
+
return await response.value();
|
|
1302
|
+
}
|
|
1303
|
+
|
|
1304
|
+
/**
|
|
1305
|
+
* Get a contact\'s details
|
|
1306
|
+
*/
|
|
1307
|
+
async getContactInfoRaw(
|
|
1308
|
+
requestParameters: GetContactInfoRequest,
|
|
1309
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1310
|
+
): Promise<runtime.ApiResponse<GetExtendedContactDetails>> {
|
|
1311
|
+
if (requestParameters.email === null || requestParameters.email === undefined) {
|
|
1312
|
+
throw new runtime.RequiredError(
|
|
1313
|
+
'email',
|
|
1314
|
+
'Required parameter requestParameters.email was null or undefined when calling getContactInfo.',
|
|
1315
|
+
);
|
|
1316
|
+
}
|
|
1317
|
+
|
|
1318
|
+
const queryParameters: any = {};
|
|
1319
|
+
|
|
1320
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1321
|
+
|
|
1322
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1323
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1324
|
+
}
|
|
1325
|
+
|
|
1326
|
+
const response = await this.request(
|
|
1327
|
+
{
|
|
1328
|
+
path: `/contacts/{email}`.replace(`{${'email'}}`, encodeURIComponent(String(requestParameters.email))),
|
|
1329
|
+
method: 'GET',
|
|
1330
|
+
headers: headerParameters,
|
|
1331
|
+
query: queryParameters,
|
|
1332
|
+
},
|
|
1333
|
+
initOverrides,
|
|
1334
|
+
);
|
|
1335
|
+
|
|
1336
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetExtendedContactDetailsFromJSON(jsonValue));
|
|
1337
|
+
}
|
|
1338
|
+
|
|
1339
|
+
/**
|
|
1340
|
+
* Get a contact\'s details
|
|
1341
|
+
*/
|
|
1342
|
+
async getContactInfo(
|
|
1343
|
+
requestParameters: GetContactInfoRequest,
|
|
1344
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1345
|
+
): Promise<GetExtendedContactDetails> {
|
|
1346
|
+
const response = await this.getContactInfoRaw(requestParameters, initOverrides);
|
|
1347
|
+
return await response.value();
|
|
1348
|
+
}
|
|
1349
|
+
|
|
1350
|
+
/**
|
|
1351
|
+
* Get email campaigns\' statistics for a contact
|
|
1352
|
+
*/
|
|
1353
|
+
async getContactStatsRaw(
|
|
1354
|
+
requestParameters: GetContactStatsRequest,
|
|
1355
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1356
|
+
): Promise<runtime.ApiResponse<GetContactCampaignStats>> {
|
|
1357
|
+
if (requestParameters.email === null || requestParameters.email === undefined) {
|
|
1358
|
+
throw new runtime.RequiredError(
|
|
1359
|
+
'email',
|
|
1360
|
+
'Required parameter requestParameters.email was null or undefined when calling getContactStats.',
|
|
1361
|
+
);
|
|
1362
|
+
}
|
|
1363
|
+
|
|
1364
|
+
const queryParameters: any = {};
|
|
1365
|
+
|
|
1366
|
+
if (requestParameters.startDate !== undefined) {
|
|
1367
|
+
queryParameters['startDate'] = (requestParameters.startDate as any).toISOString().substring(0, 10);
|
|
1368
|
+
}
|
|
1369
|
+
|
|
1370
|
+
if (requestParameters.endDate !== undefined) {
|
|
1371
|
+
queryParameters['endDate'] = (requestParameters.endDate as any).toISOString().substring(0, 10);
|
|
1372
|
+
}
|
|
1373
|
+
|
|
1374
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1375
|
+
|
|
1376
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1377
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1378
|
+
}
|
|
1379
|
+
|
|
1380
|
+
const response = await this.request(
|
|
1381
|
+
{
|
|
1382
|
+
path: `/contacts/{email}/campaignStats`.replace(`{${'email'}}`, encodeURIComponent(String(requestParameters.email))),
|
|
1383
|
+
method: 'GET',
|
|
1384
|
+
headers: headerParameters,
|
|
1385
|
+
query: queryParameters,
|
|
1386
|
+
},
|
|
1387
|
+
initOverrides,
|
|
1388
|
+
);
|
|
1389
|
+
|
|
1390
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetContactCampaignStatsFromJSON(jsonValue));
|
|
1391
|
+
}
|
|
1392
|
+
|
|
1393
|
+
/**
|
|
1394
|
+
* Get email campaigns\' statistics for a contact
|
|
1395
|
+
*/
|
|
1396
|
+
async getContactStats(
|
|
1397
|
+
requestParameters: GetContactStatsRequest,
|
|
1398
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1399
|
+
): Promise<GetContactCampaignStats> {
|
|
1400
|
+
const response = await this.getContactStatsRaw(requestParameters, initOverrides);
|
|
1401
|
+
return await response.value();
|
|
1402
|
+
}
|
|
1403
|
+
|
|
1404
|
+
/**
|
|
1405
|
+
* Get all the contacts
|
|
1406
|
+
*/
|
|
1407
|
+
async getContactsRaw(
|
|
1408
|
+
requestParameters: GetContactsRequest,
|
|
1409
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1410
|
+
): Promise<runtime.ApiResponse<GetContacts>> {
|
|
1411
|
+
const queryParameters: any = {};
|
|
1412
|
+
|
|
1413
|
+
if (requestParameters.limit !== undefined) {
|
|
1414
|
+
queryParameters['limit'] = requestParameters.limit;
|
|
1415
|
+
}
|
|
1416
|
+
|
|
1417
|
+
if (requestParameters.offset !== undefined) {
|
|
1418
|
+
queryParameters['offset'] = requestParameters.offset;
|
|
1419
|
+
}
|
|
1420
|
+
|
|
1421
|
+
if (requestParameters.modifiedSince !== undefined) {
|
|
1422
|
+
queryParameters['modifiedSince'] = (requestParameters.modifiedSince as any).toISOString();
|
|
1423
|
+
}
|
|
1424
|
+
|
|
1425
|
+
if (requestParameters.createdSince !== undefined) {
|
|
1426
|
+
queryParameters['createdSince'] = (requestParameters.createdSince as any).toISOString();
|
|
1427
|
+
}
|
|
1428
|
+
|
|
1429
|
+
if (requestParameters.sort !== undefined) {
|
|
1430
|
+
queryParameters['sort'] = requestParameters.sort;
|
|
1431
|
+
}
|
|
1432
|
+
|
|
1433
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1434
|
+
|
|
1435
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1436
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1437
|
+
}
|
|
1438
|
+
|
|
1439
|
+
const response = await this.request(
|
|
1440
|
+
{
|
|
1441
|
+
path: `/contacts`,
|
|
1442
|
+
method: 'GET',
|
|
1443
|
+
headers: headerParameters,
|
|
1444
|
+
query: queryParameters,
|
|
1445
|
+
},
|
|
1446
|
+
initOverrides,
|
|
1447
|
+
);
|
|
1448
|
+
|
|
1449
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetContactsFromJSON(jsonValue));
|
|
1450
|
+
}
|
|
1451
|
+
|
|
1452
|
+
/**
|
|
1453
|
+
* Get all the contacts
|
|
1454
|
+
*/
|
|
1455
|
+
async getContacts(
|
|
1456
|
+
requestParameters: GetContactsRequest = {},
|
|
1457
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1458
|
+
): Promise<GetContacts> {
|
|
1459
|
+
const response = await this.getContactsRaw(requestParameters, initOverrides);
|
|
1460
|
+
return await response.value();
|
|
1461
|
+
}
|
|
1462
|
+
|
|
1463
|
+
/**
|
|
1464
|
+
* Get contacts in a list
|
|
1465
|
+
*/
|
|
1466
|
+
async getContactsFromListRaw(
|
|
1467
|
+
requestParameters: GetContactsFromListRequest,
|
|
1468
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1469
|
+
): Promise<runtime.ApiResponse<GetContacts>> {
|
|
1470
|
+
if (requestParameters.listId === null || requestParameters.listId === undefined) {
|
|
1471
|
+
throw new runtime.RequiredError(
|
|
1472
|
+
'listId',
|
|
1473
|
+
'Required parameter requestParameters.listId was null or undefined when calling getContactsFromList.',
|
|
1474
|
+
);
|
|
1475
|
+
}
|
|
1476
|
+
|
|
1477
|
+
const queryParameters: any = {};
|
|
1478
|
+
|
|
1479
|
+
if (requestParameters.modifiedSince !== undefined) {
|
|
1480
|
+
queryParameters['modifiedSince'] = (requestParameters.modifiedSince as any).toISOString();
|
|
1481
|
+
}
|
|
1482
|
+
|
|
1483
|
+
if (requestParameters.limit !== undefined) {
|
|
1484
|
+
queryParameters['limit'] = requestParameters.limit;
|
|
1485
|
+
}
|
|
1486
|
+
|
|
1487
|
+
if (requestParameters.offset !== undefined) {
|
|
1488
|
+
queryParameters['offset'] = requestParameters.offset;
|
|
1489
|
+
}
|
|
1490
|
+
|
|
1491
|
+
if (requestParameters.sort !== undefined) {
|
|
1492
|
+
queryParameters['sort'] = requestParameters.sort;
|
|
1493
|
+
}
|
|
1494
|
+
|
|
1495
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1496
|
+
|
|
1497
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1498
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1499
|
+
}
|
|
1500
|
+
|
|
1501
|
+
const response = await this.request(
|
|
1502
|
+
{
|
|
1503
|
+
path: `/contacts/lists/{listId}/contacts`.replace(`{${'listId'}}`, encodeURIComponent(String(requestParameters.listId))),
|
|
1504
|
+
method: 'GET',
|
|
1505
|
+
headers: headerParameters,
|
|
1506
|
+
query: queryParameters,
|
|
1507
|
+
},
|
|
1508
|
+
initOverrides,
|
|
1509
|
+
);
|
|
1510
|
+
|
|
1511
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetContactsFromJSON(jsonValue));
|
|
1512
|
+
}
|
|
1513
|
+
|
|
1514
|
+
/**
|
|
1515
|
+
* Get contacts in a list
|
|
1516
|
+
*/
|
|
1517
|
+
async getContactsFromList(
|
|
1518
|
+
requestParameters: GetContactsFromListRequest,
|
|
1519
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1520
|
+
): Promise<GetContacts> {
|
|
1521
|
+
const response = await this.getContactsFromListRaw(requestParameters, initOverrides);
|
|
1522
|
+
return await response.value();
|
|
1523
|
+
}
|
|
1524
|
+
|
|
1525
|
+
/**
|
|
1526
|
+
* Returns a folder\'s details
|
|
1527
|
+
*/
|
|
1528
|
+
async getFolderRaw(
|
|
1529
|
+
requestParameters: GetFolderRequest,
|
|
1530
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1531
|
+
): Promise<runtime.ApiResponse<GetFolder>> {
|
|
1532
|
+
if (requestParameters.folderId === null || requestParameters.folderId === undefined) {
|
|
1533
|
+
throw new runtime.RequiredError(
|
|
1534
|
+
'folderId',
|
|
1535
|
+
'Required parameter requestParameters.folderId was null or undefined when calling getFolder.',
|
|
1536
|
+
);
|
|
1537
|
+
}
|
|
1538
|
+
|
|
1539
|
+
const queryParameters: any = {};
|
|
1540
|
+
|
|
1541
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1542
|
+
|
|
1543
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1544
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1545
|
+
}
|
|
1546
|
+
|
|
1547
|
+
const response = await this.request(
|
|
1548
|
+
{
|
|
1549
|
+
path: `/contacts/folders/{folderId}`.replace(`{${'folderId'}}`, encodeURIComponent(String(requestParameters.folderId))),
|
|
1550
|
+
method: 'GET',
|
|
1551
|
+
headers: headerParameters,
|
|
1552
|
+
query: queryParameters,
|
|
1553
|
+
},
|
|
1554
|
+
initOverrides,
|
|
1555
|
+
);
|
|
1556
|
+
|
|
1557
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetFolderFromJSON(jsonValue));
|
|
1558
|
+
}
|
|
1559
|
+
|
|
1560
|
+
/**
|
|
1561
|
+
* Returns a folder\'s details
|
|
1562
|
+
*/
|
|
1563
|
+
async getFolder(requestParameters: GetFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetFolder> {
|
|
1564
|
+
const response = await this.getFolderRaw(requestParameters, initOverrides);
|
|
1565
|
+
return await response.value();
|
|
1566
|
+
}
|
|
1567
|
+
|
|
1568
|
+
/**
|
|
1569
|
+
* Get lists in a folder
|
|
1570
|
+
*/
|
|
1571
|
+
async getFolderListsRaw(
|
|
1572
|
+
requestParameters: GetFolderListsRequest,
|
|
1573
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1574
|
+
): Promise<runtime.ApiResponse<GetFolderLists>> {
|
|
1575
|
+
if (requestParameters.folderId === null || requestParameters.folderId === undefined) {
|
|
1576
|
+
throw new runtime.RequiredError(
|
|
1577
|
+
'folderId',
|
|
1578
|
+
'Required parameter requestParameters.folderId was null or undefined when calling getFolderLists.',
|
|
1579
|
+
);
|
|
1580
|
+
}
|
|
1581
|
+
|
|
1582
|
+
const queryParameters: any = {};
|
|
1583
|
+
|
|
1584
|
+
if (requestParameters.limit !== undefined) {
|
|
1585
|
+
queryParameters['limit'] = requestParameters.limit;
|
|
1586
|
+
}
|
|
1587
|
+
|
|
1588
|
+
if (requestParameters.offset !== undefined) {
|
|
1589
|
+
queryParameters['offset'] = requestParameters.offset;
|
|
1590
|
+
}
|
|
1591
|
+
|
|
1592
|
+
if (requestParameters.sort !== undefined) {
|
|
1593
|
+
queryParameters['sort'] = requestParameters.sort;
|
|
1594
|
+
}
|
|
1595
|
+
|
|
1596
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1597
|
+
|
|
1598
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1599
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1600
|
+
}
|
|
1601
|
+
|
|
1602
|
+
const response = await this.request(
|
|
1603
|
+
{
|
|
1604
|
+
path: `/contacts/folders/{folderId}/lists`.replace(`{${'folderId'}}`, encodeURIComponent(String(requestParameters.folderId))),
|
|
1605
|
+
method: 'GET',
|
|
1606
|
+
headers: headerParameters,
|
|
1607
|
+
query: queryParameters,
|
|
1608
|
+
},
|
|
1609
|
+
initOverrides,
|
|
1610
|
+
);
|
|
1611
|
+
|
|
1612
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetFolderListsFromJSON(jsonValue));
|
|
1613
|
+
}
|
|
1614
|
+
|
|
1615
|
+
/**
|
|
1616
|
+
* Get lists in a folder
|
|
1617
|
+
*/
|
|
1618
|
+
async getFolderLists(
|
|
1619
|
+
requestParameters: GetFolderListsRequest,
|
|
1620
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1621
|
+
): Promise<GetFolderLists> {
|
|
1622
|
+
const response = await this.getFolderListsRaw(requestParameters, initOverrides);
|
|
1623
|
+
return await response.value();
|
|
1624
|
+
}
|
|
1625
|
+
|
|
1626
|
+
/**
|
|
1627
|
+
* Get all folders
|
|
1628
|
+
*/
|
|
1629
|
+
async getFoldersRaw(
|
|
1630
|
+
requestParameters: GetFoldersRequest,
|
|
1631
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1632
|
+
): Promise<runtime.ApiResponse<GetFolders>> {
|
|
1633
|
+
if (requestParameters.limit === null || requestParameters.limit === undefined) {
|
|
1634
|
+
throw new runtime.RequiredError('limit', 'Required parameter requestParameters.limit was null or undefined when calling getFolders.');
|
|
1635
|
+
}
|
|
1636
|
+
|
|
1637
|
+
if (requestParameters.offset === null || requestParameters.offset === undefined) {
|
|
1638
|
+
throw new runtime.RequiredError(
|
|
1639
|
+
'offset',
|
|
1640
|
+
'Required parameter requestParameters.offset was null or undefined when calling getFolders.',
|
|
1641
|
+
);
|
|
1642
|
+
}
|
|
1643
|
+
|
|
1644
|
+
const queryParameters: any = {};
|
|
1645
|
+
|
|
1646
|
+
if (requestParameters.limit !== undefined) {
|
|
1647
|
+
queryParameters['limit'] = requestParameters.limit;
|
|
1648
|
+
}
|
|
1649
|
+
|
|
1650
|
+
if (requestParameters.offset !== undefined) {
|
|
1651
|
+
queryParameters['offset'] = requestParameters.offset;
|
|
1652
|
+
}
|
|
1653
|
+
|
|
1654
|
+
if (requestParameters.sort !== undefined) {
|
|
1655
|
+
queryParameters['sort'] = requestParameters.sort;
|
|
1656
|
+
}
|
|
1657
|
+
|
|
1658
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1659
|
+
|
|
1660
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1661
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1662
|
+
}
|
|
1663
|
+
|
|
1664
|
+
const response = await this.request(
|
|
1665
|
+
{
|
|
1666
|
+
path: `/contacts/folders`,
|
|
1667
|
+
method: 'GET',
|
|
1668
|
+
headers: headerParameters,
|
|
1669
|
+
query: queryParameters,
|
|
1670
|
+
},
|
|
1671
|
+
initOverrides,
|
|
1672
|
+
);
|
|
1673
|
+
|
|
1674
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetFoldersFromJSON(jsonValue));
|
|
1675
|
+
}
|
|
1676
|
+
|
|
1677
|
+
/**
|
|
1678
|
+
* Get all folders
|
|
1679
|
+
*/
|
|
1680
|
+
async getFolders(requestParameters: GetFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetFolders> {
|
|
1681
|
+
const response = await this.getFoldersRaw(requestParameters, initOverrides);
|
|
1682
|
+
return await response.value();
|
|
1683
|
+
}
|
|
1684
|
+
|
|
1685
|
+
/**
|
|
1686
|
+
* Get a list\'s details
|
|
1687
|
+
*/
|
|
1688
|
+
async getListRaw(
|
|
1689
|
+
requestParameters: GetListRequest,
|
|
1690
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1691
|
+
): Promise<runtime.ApiResponse<GetExtendedList>> {
|
|
1692
|
+
if (requestParameters.listId === null || requestParameters.listId === undefined) {
|
|
1693
|
+
throw new runtime.RequiredError('listId', 'Required parameter requestParameters.listId was null or undefined when calling getList.');
|
|
1694
|
+
}
|
|
1695
|
+
|
|
1696
|
+
const queryParameters: any = {};
|
|
1697
|
+
|
|
1698
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1699
|
+
|
|
1700
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1701
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1702
|
+
}
|
|
1703
|
+
|
|
1704
|
+
const response = await this.request(
|
|
1705
|
+
{
|
|
1706
|
+
path: `/contacts/lists/{listId}`.replace(`{${'listId'}}`, encodeURIComponent(String(requestParameters.listId))),
|
|
1707
|
+
method: 'GET',
|
|
1708
|
+
headers: headerParameters,
|
|
1709
|
+
query: queryParameters,
|
|
1710
|
+
},
|
|
1711
|
+
initOverrides,
|
|
1712
|
+
);
|
|
1713
|
+
|
|
1714
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetExtendedListFromJSON(jsonValue));
|
|
1715
|
+
}
|
|
1716
|
+
|
|
1717
|
+
/**
|
|
1718
|
+
* Get a list\'s details
|
|
1719
|
+
*/
|
|
1720
|
+
async getList(requestParameters: GetListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetExtendedList> {
|
|
1721
|
+
const response = await this.getListRaw(requestParameters, initOverrides);
|
|
1722
|
+
return await response.value();
|
|
1723
|
+
}
|
|
1724
|
+
|
|
1725
|
+
/**
|
|
1726
|
+
* Get all the lists
|
|
1727
|
+
*/
|
|
1728
|
+
async getListsRaw(
|
|
1729
|
+
requestParameters: GetListsRequest,
|
|
1730
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1731
|
+
): Promise<runtime.ApiResponse<GetLists>> {
|
|
1732
|
+
const queryParameters: any = {};
|
|
1733
|
+
|
|
1734
|
+
if (requestParameters.limit !== undefined) {
|
|
1735
|
+
queryParameters['limit'] = requestParameters.limit;
|
|
1736
|
+
}
|
|
1737
|
+
|
|
1738
|
+
if (requestParameters.offset !== undefined) {
|
|
1739
|
+
queryParameters['offset'] = requestParameters.offset;
|
|
1740
|
+
}
|
|
1741
|
+
|
|
1742
|
+
if (requestParameters.sort !== undefined) {
|
|
1743
|
+
queryParameters['sort'] = requestParameters.sort;
|
|
1744
|
+
}
|
|
1745
|
+
|
|
1746
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1747
|
+
|
|
1748
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1749
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1750
|
+
}
|
|
1751
|
+
|
|
1752
|
+
const response = await this.request(
|
|
1753
|
+
{
|
|
1754
|
+
path: `/contacts/lists`,
|
|
1755
|
+
method: 'GET',
|
|
1756
|
+
headers: headerParameters,
|
|
1757
|
+
query: queryParameters,
|
|
1758
|
+
},
|
|
1759
|
+
initOverrides,
|
|
1760
|
+
);
|
|
1761
|
+
|
|
1762
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetListsFromJSON(jsonValue));
|
|
1763
|
+
}
|
|
1764
|
+
|
|
1765
|
+
/**
|
|
1766
|
+
* Get all the lists
|
|
1767
|
+
*/
|
|
1768
|
+
async getLists(requestParameters: GetListsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLists> {
|
|
1769
|
+
const response = await this.getListsRaw(requestParameters, initOverrides);
|
|
1770
|
+
return await response.value();
|
|
1771
|
+
}
|
|
1772
|
+
|
|
1773
|
+
/**
|
|
1774
|
+
* Get all the segments
|
|
1775
|
+
*/
|
|
1776
|
+
async getSegmentsRaw(
|
|
1777
|
+
requestParameters: GetSegmentsRequest,
|
|
1778
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1779
|
+
): Promise<runtime.ApiResponse<GetSegments>> {
|
|
1780
|
+
if (requestParameters.limit === null || requestParameters.limit === undefined) {
|
|
1781
|
+
throw new runtime.RequiredError(
|
|
1782
|
+
'limit',
|
|
1783
|
+
'Required parameter requestParameters.limit was null or undefined when calling getSegments.',
|
|
1784
|
+
);
|
|
1785
|
+
}
|
|
1786
|
+
|
|
1787
|
+
if (requestParameters.offset === null || requestParameters.offset === undefined) {
|
|
1788
|
+
throw new runtime.RequiredError(
|
|
1789
|
+
'offset',
|
|
1790
|
+
'Required parameter requestParameters.offset was null or undefined when calling getSegments.',
|
|
1791
|
+
);
|
|
1792
|
+
}
|
|
1793
|
+
|
|
1794
|
+
const queryParameters: any = {};
|
|
1795
|
+
|
|
1796
|
+
if (requestParameters.limit !== undefined) {
|
|
1797
|
+
queryParameters['limit'] = requestParameters.limit;
|
|
1798
|
+
}
|
|
1799
|
+
|
|
1800
|
+
if (requestParameters.offset !== undefined) {
|
|
1801
|
+
queryParameters['offset'] = requestParameters.offset;
|
|
1802
|
+
}
|
|
1803
|
+
|
|
1804
|
+
if (requestParameters.sort !== undefined) {
|
|
1805
|
+
queryParameters['sort'] = requestParameters.sort;
|
|
1806
|
+
}
|
|
1807
|
+
|
|
1808
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1809
|
+
|
|
1810
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1811
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1812
|
+
}
|
|
1813
|
+
|
|
1814
|
+
const response = await this.request(
|
|
1815
|
+
{
|
|
1816
|
+
path: `/contacts/segments`,
|
|
1817
|
+
method: 'GET',
|
|
1818
|
+
headers: headerParameters,
|
|
1819
|
+
query: queryParameters,
|
|
1820
|
+
},
|
|
1821
|
+
initOverrides,
|
|
1822
|
+
);
|
|
1823
|
+
|
|
1824
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetSegmentsFromJSON(jsonValue));
|
|
1825
|
+
}
|
|
1826
|
+
|
|
1827
|
+
/**
|
|
1828
|
+
* Get all the segments
|
|
1829
|
+
*/
|
|
1830
|
+
async getSegments(
|
|
1831
|
+
requestParameters: GetSegmentsRequest,
|
|
1832
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1833
|
+
): Promise<GetSegments> {
|
|
1834
|
+
const response = await this.getSegmentsRaw(requestParameters, initOverrides);
|
|
1835
|
+
return await response.value();
|
|
1836
|
+
}
|
|
1837
|
+
|
|
1838
|
+
/**
|
|
1839
|
+
* It returns the background process ID which on completion calls the notify URL that you have set in the input.
|
|
1840
|
+
* Import contacts
|
|
1841
|
+
*/
|
|
1842
|
+
async importContactsRaw(
|
|
1843
|
+
requestParameters: ImportContactsRequest,
|
|
1844
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1845
|
+
): Promise<runtime.ApiResponse<CreatedProcessId>> {
|
|
1846
|
+
if (requestParameters.requestContactImport === null || requestParameters.requestContactImport === undefined) {
|
|
1847
|
+
throw new runtime.RequiredError(
|
|
1848
|
+
'requestContactImport',
|
|
1849
|
+
'Required parameter requestParameters.requestContactImport was null or undefined when calling importContacts.',
|
|
1850
|
+
);
|
|
1851
|
+
}
|
|
1852
|
+
|
|
1853
|
+
const queryParameters: any = {};
|
|
1854
|
+
|
|
1855
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1856
|
+
|
|
1857
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1858
|
+
|
|
1859
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1860
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1861
|
+
}
|
|
1862
|
+
|
|
1863
|
+
const response = await this.request(
|
|
1864
|
+
{
|
|
1865
|
+
path: `/contacts/import`,
|
|
1866
|
+
method: 'POST',
|
|
1867
|
+
headers: headerParameters,
|
|
1868
|
+
query: queryParameters,
|
|
1869
|
+
body: RequestContactImportToJSON(requestParameters.requestContactImport),
|
|
1870
|
+
},
|
|
1871
|
+
initOverrides,
|
|
1872
|
+
);
|
|
1873
|
+
|
|
1874
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CreatedProcessIdFromJSON(jsonValue));
|
|
1875
|
+
}
|
|
1876
|
+
|
|
1877
|
+
/**
|
|
1878
|
+
* It returns the background process ID which on completion calls the notify URL that you have set in the input.
|
|
1879
|
+
* Import contacts
|
|
1880
|
+
*/
|
|
1881
|
+
async importContacts(
|
|
1882
|
+
requestParameters: ImportContactsRequest,
|
|
1883
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1884
|
+
): Promise<CreatedProcessId> {
|
|
1885
|
+
const response = await this.importContactsRaw(requestParameters, initOverrides);
|
|
1886
|
+
return await response.value();
|
|
1887
|
+
}
|
|
1888
|
+
|
|
1889
|
+
/**
|
|
1890
|
+
* Delete a contact from a list
|
|
1891
|
+
*/
|
|
1892
|
+
async removeContactFromListRaw(
|
|
1893
|
+
requestParameters: RemoveContactFromListRequest,
|
|
1894
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1895
|
+
): Promise<runtime.ApiResponse<PostContactInfo>> {
|
|
1896
|
+
if (requestParameters.listId === null || requestParameters.listId === undefined) {
|
|
1897
|
+
throw new runtime.RequiredError(
|
|
1898
|
+
'listId',
|
|
1899
|
+
'Required parameter requestParameters.listId was null or undefined when calling removeContactFromList.',
|
|
1900
|
+
);
|
|
1901
|
+
}
|
|
1902
|
+
|
|
1903
|
+
if (requestParameters.contactEmails === null || requestParameters.contactEmails === undefined) {
|
|
1904
|
+
throw new runtime.RequiredError(
|
|
1905
|
+
'contactEmails',
|
|
1906
|
+
'Required parameter requestParameters.contactEmails was null or undefined when calling removeContactFromList.',
|
|
1907
|
+
);
|
|
1908
|
+
}
|
|
1909
|
+
|
|
1910
|
+
const queryParameters: any = {};
|
|
1911
|
+
|
|
1912
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1913
|
+
|
|
1914
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1915
|
+
|
|
1916
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1917
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1918
|
+
}
|
|
1919
|
+
|
|
1920
|
+
const response = await this.request(
|
|
1921
|
+
{
|
|
1922
|
+
path: `/contacts/lists/{listId}/contacts/remove`.replace(`{${'listId'}}`, encodeURIComponent(String(requestParameters.listId))),
|
|
1923
|
+
method: 'POST',
|
|
1924
|
+
headers: headerParameters,
|
|
1925
|
+
query: queryParameters,
|
|
1926
|
+
body: RemoveContactFromListToJSON(requestParameters.contactEmails),
|
|
1927
|
+
},
|
|
1928
|
+
initOverrides,
|
|
1929
|
+
);
|
|
1930
|
+
|
|
1931
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => PostContactInfoFromJSON(jsonValue));
|
|
1932
|
+
}
|
|
1933
|
+
|
|
1934
|
+
/**
|
|
1935
|
+
* Delete a contact from a list
|
|
1936
|
+
*/
|
|
1937
|
+
async removeContactFromList(
|
|
1938
|
+
requestParameters: RemoveContactFromListRequest,
|
|
1939
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1940
|
+
): Promise<PostContactInfo> {
|
|
1941
|
+
const response = await this.removeContactFromListRaw(requestParameters, initOverrides);
|
|
1942
|
+
return await response.value();
|
|
1943
|
+
}
|
|
1944
|
+
|
|
1945
|
+
/**
|
|
1946
|
+
* It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv.
|
|
1947
|
+
* Export contacts
|
|
1948
|
+
*/
|
|
1949
|
+
async requestContactExportRaw(
|
|
1950
|
+
requestParameters: RequestContactExportRequest,
|
|
1951
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1952
|
+
): Promise<runtime.ApiResponse<CreatedProcessId>> {
|
|
1953
|
+
if (requestParameters.requestContactExport === null || requestParameters.requestContactExport === undefined) {
|
|
1954
|
+
throw new runtime.RequiredError(
|
|
1955
|
+
'requestContactExport',
|
|
1956
|
+
'Required parameter requestParameters.requestContactExport was null or undefined when calling requestContactExport.',
|
|
1957
|
+
);
|
|
1958
|
+
}
|
|
1959
|
+
|
|
1960
|
+
const queryParameters: any = {};
|
|
1961
|
+
|
|
1962
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1963
|
+
|
|
1964
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1965
|
+
|
|
1966
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1967
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1968
|
+
}
|
|
1969
|
+
|
|
1970
|
+
const response = await this.request(
|
|
1971
|
+
{
|
|
1972
|
+
path: `/contacts/export`,
|
|
1973
|
+
method: 'POST',
|
|
1974
|
+
headers: headerParameters,
|
|
1975
|
+
query: queryParameters,
|
|
1976
|
+
body: RequestContactExportToJSON(requestParameters.requestContactExport),
|
|
1977
|
+
},
|
|
1978
|
+
initOverrides,
|
|
1979
|
+
);
|
|
1980
|
+
|
|
1981
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CreatedProcessIdFromJSON(jsonValue));
|
|
1982
|
+
}
|
|
1983
|
+
|
|
1984
|
+
/**
|
|
1985
|
+
* It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv.
|
|
1986
|
+
* Export contacts
|
|
1987
|
+
*/
|
|
1988
|
+
async requestContactExport(
|
|
1989
|
+
requestParameters: RequestContactExportRequest,
|
|
1990
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1991
|
+
): Promise<CreatedProcessId> {
|
|
1992
|
+
const response = await this.requestContactExportRaw(requestParameters, initOverrides);
|
|
1993
|
+
return await response.value();
|
|
1994
|
+
}
|
|
1995
|
+
|
|
1996
|
+
/**
|
|
1997
|
+
* Update contact attribute
|
|
1998
|
+
*/
|
|
1999
|
+
async updateAttributeRaw(
|
|
2000
|
+
requestParameters: UpdateAttributeRequest,
|
|
2001
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
2002
|
+
): Promise<runtime.ApiResponse<void>> {
|
|
2003
|
+
if (requestParameters.attributeCategory === null || requestParameters.attributeCategory === undefined) {
|
|
2004
|
+
throw new runtime.RequiredError(
|
|
2005
|
+
'attributeCategory',
|
|
2006
|
+
'Required parameter requestParameters.attributeCategory was null or undefined when calling updateAttribute.',
|
|
2007
|
+
);
|
|
2008
|
+
}
|
|
2009
|
+
|
|
2010
|
+
if (requestParameters.attributeName === null || requestParameters.attributeName === undefined) {
|
|
2011
|
+
throw new runtime.RequiredError(
|
|
2012
|
+
'attributeName',
|
|
2013
|
+
'Required parameter requestParameters.attributeName was null or undefined when calling updateAttribute.',
|
|
2014
|
+
);
|
|
2015
|
+
}
|
|
2016
|
+
|
|
2017
|
+
if (requestParameters.updateAttribute === null || requestParameters.updateAttribute === undefined) {
|
|
2018
|
+
throw new runtime.RequiredError(
|
|
2019
|
+
'updateAttribute',
|
|
2020
|
+
'Required parameter requestParameters.updateAttribute was null or undefined when calling updateAttribute.',
|
|
2021
|
+
);
|
|
2022
|
+
}
|
|
2023
|
+
|
|
2024
|
+
const queryParameters: any = {};
|
|
2025
|
+
|
|
2026
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
2027
|
+
|
|
2028
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
2029
|
+
|
|
2030
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
2031
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
2032
|
+
}
|
|
2033
|
+
|
|
2034
|
+
const response = await this.request(
|
|
2035
|
+
{
|
|
2036
|
+
path: `/contacts/attributes/{attributeCategory}/{attributeName}`
|
|
2037
|
+
.replace(`{${'attributeCategory'}}`, encodeURIComponent(String(requestParameters.attributeCategory)))
|
|
2038
|
+
.replace(`{${'attributeName'}}`, encodeURIComponent(String(requestParameters.attributeName))),
|
|
2039
|
+
method: 'PUT',
|
|
2040
|
+
headers: headerParameters,
|
|
2041
|
+
query: queryParameters,
|
|
2042
|
+
body: UpdateAttributeToJSON(requestParameters.updateAttribute),
|
|
2043
|
+
},
|
|
2044
|
+
initOverrides,
|
|
2045
|
+
);
|
|
2046
|
+
|
|
2047
|
+
return new runtime.VoidApiResponse(response);
|
|
2048
|
+
}
|
|
2049
|
+
|
|
2050
|
+
/**
|
|
2051
|
+
* Update contact attribute
|
|
2052
|
+
*/
|
|
2053
|
+
async updateAttribute(
|
|
2054
|
+
requestParameters: UpdateAttributeRequest,
|
|
2055
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
2056
|
+
): Promise<void> {
|
|
2057
|
+
await this.updateAttributeRaw(requestParameters, initOverrides);
|
|
2058
|
+
}
|
|
2059
|
+
|
|
2060
|
+
/**
|
|
2061
|
+
* Update a contact
|
|
2062
|
+
*/
|
|
2063
|
+
async updateContactRaw(
|
|
2064
|
+
requestParameters: UpdateContactRequest,
|
|
2065
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
2066
|
+
): Promise<runtime.ApiResponse<void>> {
|
|
2067
|
+
if (requestParameters.email === null || requestParameters.email === undefined) {
|
|
2068
|
+
throw new runtime.RequiredError(
|
|
2069
|
+
'email',
|
|
2070
|
+
'Required parameter requestParameters.email was null or undefined when calling updateContact.',
|
|
2071
|
+
);
|
|
2072
|
+
}
|
|
2073
|
+
|
|
2074
|
+
if (requestParameters.updateContact === null || requestParameters.updateContact === undefined) {
|
|
2075
|
+
throw new runtime.RequiredError(
|
|
2076
|
+
'updateContact',
|
|
2077
|
+
'Required parameter requestParameters.updateContact was null or undefined when calling updateContact.',
|
|
2078
|
+
);
|
|
2079
|
+
}
|
|
2080
|
+
|
|
2081
|
+
const queryParameters: any = {};
|
|
2082
|
+
|
|
2083
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
2084
|
+
|
|
2085
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
2086
|
+
|
|
2087
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
2088
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
2089
|
+
}
|
|
2090
|
+
|
|
2091
|
+
const response = await this.request(
|
|
2092
|
+
{
|
|
2093
|
+
path: `/contacts/{email}`.replace(`{${'email'}}`, encodeURIComponent(String(requestParameters.email))),
|
|
2094
|
+
method: 'PUT',
|
|
2095
|
+
headers: headerParameters,
|
|
2096
|
+
query: queryParameters,
|
|
2097
|
+
body: UpdateContactToJSON(requestParameters.updateContact),
|
|
2098
|
+
},
|
|
2099
|
+
initOverrides,
|
|
2100
|
+
);
|
|
2101
|
+
|
|
2102
|
+
return new runtime.VoidApiResponse(response);
|
|
2103
|
+
}
|
|
2104
|
+
|
|
2105
|
+
/**
|
|
2106
|
+
* Update a contact
|
|
2107
|
+
*/
|
|
2108
|
+
async updateContact(requestParameters: UpdateContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
2109
|
+
await this.updateContactRaw(requestParameters, initOverrides);
|
|
2110
|
+
}
|
|
2111
|
+
|
|
2112
|
+
/**
|
|
2113
|
+
* Update a folder
|
|
2114
|
+
*/
|
|
2115
|
+
async updateFolderRaw(
|
|
2116
|
+
requestParameters: UpdateFolderRequest,
|
|
2117
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
2118
|
+
): Promise<runtime.ApiResponse<void>> {
|
|
2119
|
+
if (requestParameters.folderId === null || requestParameters.folderId === undefined) {
|
|
2120
|
+
throw new runtime.RequiredError(
|
|
2121
|
+
'folderId',
|
|
2122
|
+
'Required parameter requestParameters.folderId was null or undefined when calling updateFolder.',
|
|
2123
|
+
);
|
|
2124
|
+
}
|
|
2125
|
+
|
|
2126
|
+
if (requestParameters.updateFolder === null || requestParameters.updateFolder === undefined) {
|
|
2127
|
+
throw new runtime.RequiredError(
|
|
2128
|
+
'updateFolder',
|
|
2129
|
+
'Required parameter requestParameters.updateFolder was null or undefined when calling updateFolder.',
|
|
2130
|
+
);
|
|
2131
|
+
}
|
|
2132
|
+
|
|
2133
|
+
const queryParameters: any = {};
|
|
2134
|
+
|
|
2135
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
2136
|
+
|
|
2137
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
2138
|
+
|
|
2139
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
2140
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
2141
|
+
}
|
|
2142
|
+
|
|
2143
|
+
const response = await this.request(
|
|
2144
|
+
{
|
|
2145
|
+
path: `/contacts/folders/{folderId}`.replace(`{${'folderId'}}`, encodeURIComponent(String(requestParameters.folderId))),
|
|
2146
|
+
method: 'PUT',
|
|
2147
|
+
headers: headerParameters,
|
|
2148
|
+
query: queryParameters,
|
|
2149
|
+
body: CreateUpdateFolderToJSON(requestParameters.updateFolder),
|
|
2150
|
+
},
|
|
2151
|
+
initOverrides,
|
|
2152
|
+
);
|
|
2153
|
+
|
|
2154
|
+
return new runtime.VoidApiResponse(response);
|
|
2155
|
+
}
|
|
2156
|
+
|
|
2157
|
+
/**
|
|
2158
|
+
* Update a folder
|
|
2159
|
+
*/
|
|
2160
|
+
async updateFolder(requestParameters: UpdateFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
2161
|
+
await this.updateFolderRaw(requestParameters, initOverrides);
|
|
2162
|
+
}
|
|
2163
|
+
|
|
2164
|
+
/**
|
|
2165
|
+
* Update a list
|
|
2166
|
+
*/
|
|
2167
|
+
async updateListRaw(
|
|
2168
|
+
requestParameters: UpdateListRequest,
|
|
2169
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
2170
|
+
): Promise<runtime.ApiResponse<void>> {
|
|
2171
|
+
if (requestParameters.listId === null || requestParameters.listId === undefined) {
|
|
2172
|
+
throw new runtime.RequiredError(
|
|
2173
|
+
'listId',
|
|
2174
|
+
'Required parameter requestParameters.listId was null or undefined when calling updateList.',
|
|
2175
|
+
);
|
|
2176
|
+
}
|
|
2177
|
+
|
|
2178
|
+
if (requestParameters.updateList === null || requestParameters.updateList === undefined) {
|
|
2179
|
+
throw new runtime.RequiredError(
|
|
2180
|
+
'updateList',
|
|
2181
|
+
'Required parameter requestParameters.updateList was null or undefined when calling updateList.',
|
|
2182
|
+
);
|
|
2183
|
+
}
|
|
2184
|
+
|
|
2185
|
+
const queryParameters: any = {};
|
|
2186
|
+
|
|
2187
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
2188
|
+
|
|
2189
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
2190
|
+
|
|
2191
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
2192
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
2193
|
+
}
|
|
2194
|
+
|
|
2195
|
+
const response = await this.request(
|
|
2196
|
+
{
|
|
2197
|
+
path: `/contacts/lists/{listId}`.replace(`{${'listId'}}`, encodeURIComponent(String(requestParameters.listId))),
|
|
2198
|
+
method: 'PUT',
|
|
2199
|
+
headers: headerParameters,
|
|
2200
|
+
query: queryParameters,
|
|
2201
|
+
body: UpdateListToJSON(requestParameters.updateList),
|
|
2202
|
+
},
|
|
2203
|
+
initOverrides,
|
|
2204
|
+
);
|
|
2205
|
+
|
|
2206
|
+
return new runtime.VoidApiResponse(response);
|
|
2207
|
+
}
|
|
2208
|
+
|
|
2209
|
+
/**
|
|
2210
|
+
* Update a list
|
|
2211
|
+
*/
|
|
2212
|
+
async updateList(requestParameters: UpdateListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
2213
|
+
await this.updateListRaw(requestParameters, initOverrides);
|
|
2214
|
+
}
|
|
2215
|
+
}
|
|
2216
|
+
|
|
2217
|
+
/**
|
|
2218
|
+
* @export
|
|
2219
|
+
* @enum {string}
|
|
2220
|
+
*/
|
|
2221
|
+
export enum CreateAttributeAttributeCategoryEnum {
|
|
2222
|
+
Normal = 'normal',
|
|
2223
|
+
Transactional = 'transactional',
|
|
2224
|
+
Category = 'category',
|
|
2225
|
+
Calculated = 'calculated',
|
|
2226
|
+
Global = 'global',
|
|
2227
|
+
}
|
|
2228
|
+
/**
|
|
2229
|
+
* @export
|
|
2230
|
+
* @enum {string}
|
|
2231
|
+
*/
|
|
2232
|
+
export enum DeleteAttributeAttributeCategoryEnum {
|
|
2233
|
+
Normal = 'normal',
|
|
2234
|
+
Transactional = 'transactional',
|
|
2235
|
+
Category = 'category',
|
|
2236
|
+
Calculated = 'calculated',
|
|
2237
|
+
Global = 'global',
|
|
2238
|
+
}
|
|
2239
|
+
/**
|
|
2240
|
+
* @export
|
|
2241
|
+
* @enum {string}
|
|
2242
|
+
*/
|
|
2243
|
+
export enum GetContactsSortEnum {
|
|
2244
|
+
Asc = 'asc',
|
|
2245
|
+
Desc = 'desc',
|
|
2246
|
+
}
|
|
2247
|
+
/**
|
|
2248
|
+
* @export
|
|
2249
|
+
* @enum {string}
|
|
2250
|
+
*/
|
|
2251
|
+
export enum GetContactsFromListSortEnum {
|
|
2252
|
+
Asc = 'asc',
|
|
2253
|
+
Desc = 'desc',
|
|
2254
|
+
}
|
|
2255
|
+
/**
|
|
2256
|
+
* @export
|
|
2257
|
+
* @enum {string}
|
|
2258
|
+
*/
|
|
2259
|
+
export enum GetFolderListsSortEnum {
|
|
2260
|
+
Asc = 'asc',
|
|
2261
|
+
Desc = 'desc',
|
|
2262
|
+
}
|
|
2263
|
+
/**
|
|
2264
|
+
* @export
|
|
2265
|
+
* @enum {string}
|
|
2266
|
+
*/
|
|
2267
|
+
export enum GetFoldersSortEnum {
|
|
2268
|
+
Asc = 'asc',
|
|
2269
|
+
Desc = 'desc',
|
|
2270
|
+
}
|
|
2271
|
+
/**
|
|
2272
|
+
* @export
|
|
2273
|
+
* @enum {string}
|
|
2274
|
+
*/
|
|
2275
|
+
export enum GetListsSortEnum {
|
|
2276
|
+
Asc = 'asc',
|
|
2277
|
+
Desc = 'desc',
|
|
2278
|
+
}
|
|
2279
|
+
/**
|
|
2280
|
+
* @export
|
|
2281
|
+
* @enum {string}
|
|
2282
|
+
*/
|
|
2283
|
+
export enum GetSegmentsSortEnum {
|
|
2284
|
+
Asc = 'asc',
|
|
2285
|
+
Desc = 'desc',
|
|
2286
|
+
}
|
|
2287
|
+
/**
|
|
2288
|
+
* @export
|
|
2289
|
+
* @enum {string}
|
|
2290
|
+
*/
|
|
2291
|
+
export enum UpdateAttributeAttributeCategoryEnum {
|
|
2292
|
+
Category = 'category',
|
|
2293
|
+
Calculated = 'calculated',
|
|
2294
|
+
Global = 'global',
|
|
2295
|
+
}
|