@getbrevo/brevo 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.eslintignore +2 -0
- package/.eslintrc +22 -0
- package/.github/CODEOWNERS +1 -0
- package/.github/workflows/release.yml +20 -0
- package/.swagger-codegen/VERSION +1 -0
- package/.swagger-codegen-ignore +23 -0
- package/.travis.yml +5 -0
- package/LICENSE.md +15 -0
- package/README.md +683 -0
- package/docs/AbTestCampaignResult.md +43 -0
- package/docs/AbTestCampaignResultClickedLinks.md +9 -0
- package/docs/AbTestCampaignResultStatistics.md +13 -0
- package/docs/AbTestVersionClicks.md +7 -0
- package/docs/AbTestVersionClicksInner.md +10 -0
- package/docs/AbTestVersionStats.md +9 -0
- package/docs/AccountApi.md +119 -0
- package/docs/AddChildDomain.md +8 -0
- package/docs/AddContactToList.md +9 -0
- package/docs/AddCredits.md +9 -0
- package/docs/AuthenticateDomainModel.md +9 -0
- package/docs/BlockDomain.md +8 -0
- package/docs/Body.md +10 -0
- package/docs/Body1.md +10 -0
- package/docs/Body10.md +11 -0
- package/docs/Body11.md +8 -0
- package/docs/Body12.md +11 -0
- package/docs/Body2.md +11 -0
- package/docs/Body3.md +9 -0
- package/docs/Body4.md +9 -0
- package/docs/Body5.md +11 -0
- package/docs/Body6.md +18 -0
- package/docs/Body7.md +17 -0
- package/docs/Body8.md +13 -0
- package/docs/Body9.md +8 -0
- package/docs/BodyVariablesItems.md +7 -0
- package/docs/CompaniesApi.md +406 -0
- package/docs/CompaniesList.md +8 -0
- package/docs/Company.md +11 -0
- package/docs/CompanyAttributes.md +7 -0
- package/docs/CompanyAttributesInner.md +12 -0
- package/docs/ComponentItems.md +9 -0
- package/docs/ContactsApi.md +1691 -0
- package/docs/ConversationsApi.md +518 -0
- package/docs/ConversationsMessage.md +28 -0
- package/docs/ConversationsMessageFile.md +12 -0
- package/docs/ConversationsMessageFileImageInfo.md +10 -0
- package/docs/CouponsApi.md +291 -0
- package/docs/CreateApiKeyRequest.md +9 -0
- package/docs/CreateApiKeyResponse.md +9 -0
- package/docs/CreateAttribute.md +30 -0
- package/docs/CreateAttributeEnumeration.md +9 -0
- package/docs/CreateCategoryModel.md +8 -0
- package/docs/CreateChild.md +32 -0
- package/docs/CreateContact.md +15 -0
- package/docs/CreateCouponCollection.md +9 -0
- package/docs/CreateCoupons.md +9 -0
- package/docs/CreateDoiContact.md +13 -0
- package/docs/CreateDomain.md +8 -0
- package/docs/CreateDomainModel.md +11 -0
- package/docs/CreateDomainModelDnsRecords.md +9 -0
- package/docs/CreateDomainModelDnsRecordsDkimRecord.md +11 -0
- package/docs/CreateEmailCampaign.md +49 -0
- package/docs/CreateEmailCampaignRecipients.md +10 -0
- package/docs/CreateEmailCampaignSender.md +10 -0
- package/docs/CreateExternalFeed.md +29 -0
- package/docs/CreateList.md +9 -0
- package/docs/CreateModel.md +8 -0
- package/docs/CreateProductModel.md +8 -0
- package/docs/CreateReseller.md +9 -0
- package/docs/CreateSender.md +10 -0
- package/docs/CreateSenderIps.md +10 -0
- package/docs/CreateSenderModel.md +10 -0
- package/docs/CreateSmsCampaign.md +15 -0
- package/docs/CreateSmsCampaignRecipients.md +9 -0
- package/docs/CreateSmtpEmail.md +9 -0
- package/docs/CreateSmtpTemplate.md +17 -0
- package/docs/CreateSmtpTemplateSender.md +10 -0
- package/docs/CreateSubAccount.md +30 -0
- package/docs/CreateSubAccountResponse.md +8 -0
- package/docs/CreateUpdateBatchCategory.md +9 -0
- package/docs/CreateUpdateBatchCategoryModel.md +9 -0
- package/docs/CreateUpdateBatchProducts.md +9 -0
- package/docs/CreateUpdateBatchProductsModel.md +9 -0
- package/docs/CreateUpdateCategories.md +11 -0
- package/docs/CreateUpdateCategory.md +12 -0
- package/docs/CreateUpdateContactModel.md +8 -0
- package/docs/CreateUpdateFolder.md +8 -0
- package/docs/CreateUpdateProduct.md +18 -0
- package/docs/CreateUpdateProducts.md +17 -0
- package/docs/CreateWebhook.md +66 -0
- package/docs/CreateWhatsAppCampaign.md +11 -0
- package/docs/CreateWhatsAppCampaignRecipients.md +10 -0
- package/docs/CreateWhatsAppTemplate.md +24 -0
- package/docs/CreatedBatchId.md +8 -0
- package/docs/CreatedProcessId.md +8 -0
- package/docs/Deal.md +11 -0
- package/docs/DealAttributes.md +7 -0
- package/docs/DealAttributesInner.md +12 -0
- package/docs/DealsApi.md +512 -0
- package/docs/DealsList.md +8 -0
- package/docs/DeleteHardbounces.md +10 -0
- package/docs/DomainsApi.md +278 -0
- package/docs/EcommerceApi.md +645 -0
- package/docs/EmailCampaignsApi.md +766 -0
- package/docs/EmailExportRecipients.md +32 -0
- package/docs/ErrorModel.md +48 -0
- package/docs/ExportWebhooksHistory.md +57 -0
- package/docs/ExternalFeedsApi.md +309 -0
- package/docs/FileData.md +14 -0
- package/docs/FileDownloadableLink.md +8 -0
- package/docs/FileList.md +7 -0
- package/docs/FilesApi.md +304 -0
- package/docs/GetAccount.md +10 -0
- package/docs/GetAccountActivity.md +8 -0
- package/docs/GetAccountActivityLogs.md +12 -0
- package/docs/GetAccountMarketingAutomation.md +9 -0
- package/docs/GetAccountPlan.md +39 -0
- package/docs/GetAccountRelay.md +9 -0
- package/docs/GetAccountRelayData.md +10 -0
- package/docs/GetAggregatedReport.md +20 -0
- package/docs/GetAllExternalFeeds.md +9 -0
- package/docs/GetAllExternalFeedsFeeds.md +32 -0
- package/docs/GetAttributes.md +8 -0
- package/docs/GetAttributesAttributes.md +46 -0
- package/docs/GetAttributesEnumeration.md +9 -0
- package/docs/GetBlockedDomains.md +8 -0
- package/docs/GetCampaignOverview.md +51 -0
- package/docs/GetCampaignRecipients.md +9 -0
- package/docs/GetCampaignStats.md +23 -0
- package/docs/GetCategories.md +9 -0
- package/docs/GetCategoryDetails.md +13 -0
- package/docs/GetChildAccountCreationStatus.md +8 -0
- package/docs/GetChildDomain.md +9 -0
- package/docs/GetChildDomains.md +7 -0
- package/docs/GetChildInfo.md +12 -0
- package/docs/GetChildInfoApiKeys.md +9 -0
- package/docs/GetChildInfoApiKeysV2.md +9 -0
- package/docs/GetChildInfoApiKeysV3.md +9 -0
- package/docs/GetChildInfoCredits.md +9 -0
- package/docs/GetChildInfoStatistics.md +10 -0
- package/docs/GetChildrenList.md +9 -0
- package/docs/GetClient.md +11 -0
- package/docs/GetContactCampaignStats.md +16 -0
- package/docs/GetContactCampaignStatsClicked.md +9 -0
- package/docs/GetContactCampaignStatsOpened.md +11 -0
- package/docs/GetContactCampaignStatsTransacAttributes.md +10 -0
- package/docs/GetContactCampaignStatsUnsubscriptions.md +9 -0
- package/docs/GetContactDetails.md +16 -0
- package/docs/GetContacts.md +9 -0
- package/docs/GetCouponCollection.md +13 -0
- package/docs/GetDeviceBrowserStats.md +11 -0
- package/docs/GetDomainConfigurationModel.md +11 -0
- package/docs/GetDomainsList.md +8 -0
- package/docs/GetDomainsListDomains.md +12 -0
- package/docs/GetEmailCampaign.md +9 -0
- package/docs/GetEmailCampaigns.md +9 -0
- package/docs/GetEmailEventReport.md +8 -0
- package/docs/GetEmailEventReportEvents.md +53 -0
- package/docs/GetExtendedCampaignOverview.md +23 -0
- package/docs/GetExtendedCampaignOverviewSender.md +10 -0
- package/docs/GetExtendedCampaignStats.md +15 -0
- package/docs/GetExtendedCampaignStatsGlobalStats.md +7 -0
- package/docs/GetExtendedClient.md +8 -0
- package/docs/GetExtendedClientAddress.md +11 -0
- package/docs/GetExtendedContactDetails.md +8 -0
- package/docs/GetExtendedContactDetailsStatistics.md +16 -0
- package/docs/GetExtendedContactDetailsStatisticsClicked.md +9 -0
- package/docs/GetExtendedContactDetailsStatisticsLinks.md +11 -0
- package/docs/GetExtendedContactDetailsStatisticsMessagesSent.md +9 -0
- package/docs/GetExtendedContactDetailsStatisticsOpened.md +11 -0
- package/docs/GetExtendedContactDetailsStatisticsUnsubscriptions.md +9 -0
- package/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +9 -0
- package/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +10 -0
- package/docs/GetExtendedList.md +11 -0
- package/docs/GetExtendedListCampaignStats.md +9 -0
- package/docs/GetExternalFeedByUUID.md +32 -0
- package/docs/GetExternalFeedByUUIDHeaders.md +9 -0
- package/docs/GetFolder.md +12 -0
- package/docs/GetFolderLists.md +9 -0
- package/docs/GetFolders.md +9 -0
- package/docs/GetInboundEmailEvents.md +8 -0
- package/docs/GetInboundEmailEventsByUuid.md +15 -0
- package/docs/GetInboundEmailEventsByUuidAttachments.md +11 -0
- package/docs/GetInboundEmailEventsByUuidLogs.md +24 -0
- package/docs/GetInboundEmailEventsEvents.md +11 -0
- package/docs/GetInvitedUsersList.md +8 -0
- package/docs/GetInvitedUsersListFeatureAccess.md +10 -0
- package/docs/GetInvitedUsersListUsers.md +11 -0
- package/docs/GetIp.md +11 -0
- package/docs/GetIpFromSender.md +11 -0
- package/docs/GetIps.md +8 -0
- package/docs/GetIpsFromSender.md +8 -0
- package/docs/GetList.md +12 -0
- package/docs/GetLists.md +9 -0
- package/docs/GetProcess.md +24 -0
- package/docs/GetProcesses.md +9 -0
- package/docs/GetProductDetails.md +22 -0
- package/docs/GetProducts.md +9 -0
- package/docs/GetReports.md +8 -0
- package/docs/GetReportsReports.md +20 -0
- package/docs/GetScheduledEmailByBatchId.md +9 -0
- package/docs/GetScheduledEmailByBatchIdBatches.md +25 -0
- package/docs/GetScheduledEmailByMessageId.md +25 -0
- package/docs/GetSegments.md +9 -0
- package/docs/GetSegmentsSegments.md +11 -0
- package/docs/GetSendersList.md +8 -0
- package/docs/GetSendersListIps.md +10 -0
- package/docs/GetSendersListSenders.md +12 -0
- package/docs/GetSharedTemplateUrl.md +8 -0
- package/docs/GetSmsCampaign.md +9 -0
- package/docs/GetSmsCampaignOverview.md +34 -0
- package/docs/GetSmsCampaignRecipients.md +7 -0
- package/docs/GetSmsCampaignStats.md +14 -0
- package/docs/GetSmsCampaigns.md +9 -0
- package/docs/GetSmsEventReport.md +8 -0
- package/docs/GetSmsEventReportEvents.md +41 -0
- package/docs/GetSmtpTemplateOverview.md +20 -0
- package/docs/GetSmtpTemplateOverviewSender.md +10 -0
- package/docs/GetSmtpTemplates.md +9 -0
- package/docs/GetSsoToken.md +8 -0
- package/docs/GetStatsByBrowser.md +7 -0
- package/docs/GetStatsByDevice.md +11 -0
- package/docs/GetStatsByDomain.md +7 -0
- package/docs/GetTransacAggregatedSmsReport.md +17 -0
- package/docs/GetTransacBlockedContacts.md +9 -0
- package/docs/GetTransacBlockedContactsContacts.md +11 -0
- package/docs/GetTransacBlockedContactsReason.md +28 -0
- package/docs/GetTransacEmailContent.md +14 -0
- package/docs/GetTransacEmailContentEvents.md +9 -0
- package/docs/GetTransacEmailsList.md +9 -0
- package/docs/GetTransacEmailsListTransactionalEmails.md +15 -0
- package/docs/GetTransacSmsReport.md +8 -0
- package/docs/GetTransacSmsReportReports.md +17 -0
- package/docs/GetUserPermission.md +10 -0
- package/docs/GetUserPermissionPrivileges.md +9 -0
- package/docs/GetWATemplates.md +9 -0
- package/docs/GetWATemplatesTemplates.md +15 -0
- package/docs/GetWebhook.md +25 -0
- package/docs/GetWebhooks.md +8 -0
- package/docs/GetWhatsAppConfig.md +39 -0
- package/docs/GetWhatsappCampaignOverview.md +39 -0
- package/docs/GetWhatsappCampaigns.md +9 -0
- package/docs/GetWhatsappCampaignsCampaigns.md +41 -0
- package/docs/GetWhatsappEventReport.md +8 -0
- package/docs/GetWhatsappEventReportEvents.md +36 -0
- package/docs/InboundParsingApi.md +190 -0
- package/docs/InlineResponse200.md +8 -0
- package/docs/InlineResponse2001.md +10 -0
- package/docs/InlineResponse201.md +8 -0
- package/docs/InlineResponse2011.md +8 -0
- package/docs/InlineResponse2012.md +8 -0
- package/docs/InlineResponse2013.md +8 -0
- package/docs/InlineResponse2014.md +8 -0
- package/docs/ManageIp.md +8 -0
- package/docs/MasterAccountApi.md +524 -0
- package/docs/MasterDetailsResponse.md +14 -0
- package/docs/MasterDetailsResponseBillingInfo.md +11 -0
- package/docs/MasterDetailsResponseBillingInfoAddress.md +12 -0
- package/docs/MasterDetailsResponseBillingInfoName.md +9 -0
- package/docs/MasterDetailsResponsePlanInfo.md +24 -0
- package/docs/MasterDetailsResponsePlanInfoFeatures.md +12 -0
- package/docs/Note.md +14 -0
- package/docs/NoteData.md +11 -0
- package/docs/NoteId.md +8 -0
- package/docs/NoteList.md +7 -0
- package/docs/NotesApi.md +299 -0
- package/docs/Order.md +16 -0
- package/docs/OrderBatch.md +9 -0
- package/docs/OrderBilling.md +14 -0
- package/docs/OrderProducts.md +11 -0
- package/docs/Otp.md +8 -0
- package/docs/Pipeline.md +10 -0
- package/docs/PipelineStage.md +9 -0
- package/docs/Pipelines.md +7 -0
- package/docs/PostContactInfo.md +8 -0
- package/docs/PostContactInfoContacts.md +11 -0
- package/docs/PostSendFailed.md +12 -0
- package/docs/PostSendSmsTestFailed.md +11 -0
- package/docs/ProcessApi.md +123 -0
- package/docs/RemainingCreditModel.md +9 -0
- package/docs/RemainingCreditModelChild.md +9 -0
- package/docs/RemainingCreditModelReseller.md +9 -0
- package/docs/RemoveContactFromList.md +10 -0
- package/docs/RemoveCredits.md +9 -0
- package/docs/RequestContactExport.md +10 -0
- package/docs/RequestContactExportCustomContactFilter.md +62 -0
- package/docs/RequestContactImport.md +17 -0
- package/docs/RequestContactImportNewList.md +9 -0
- package/docs/RequestSmsRecipientExport.md +28 -0
- package/docs/ResellerApi.md +924 -0
- package/docs/SMSCampaignsApi.md +589 -0
- package/docs/ScheduleSmtpEmail.md +10 -0
- package/docs/SendReport.md +28 -0
- package/docs/SendReportEmail.md +9 -0
- package/docs/SendSms.md +12 -0
- package/docs/SendSmtpEmail.md +23 -0
- package/docs/SendSmtpEmailAttachment.md +10 -0
- package/docs/SendSmtpEmailBcc.md +9 -0
- package/docs/SendSmtpEmailCc.md +9 -0
- package/docs/SendSmtpEmailMessageVersions.md +13 -0
- package/docs/SendSmtpEmailReplyTo.md +9 -0
- package/docs/SendSmtpEmailReplyTo1.md +9 -0
- package/docs/SendSmtpEmailSender.md +10 -0
- package/docs/SendSmtpEmailTo.md +9 -0
- package/docs/SendSmtpEmailTo1.md +9 -0
- package/docs/SendTestEmail.md +8 -0
- package/docs/SendTestSms.md +8 -0
- package/docs/SendTransacSms.md +26 -0
- package/docs/SendWhatsappMessage.md +11 -0
- package/docs/SendersApi.md +399 -0
- package/docs/SsoTokenRequest.md +33 -0
- package/docs/SubAccountDetailsResponse.md +11 -0
- package/docs/SubAccountDetailsResponsePlanInfo.md +10 -0
- package/docs/SubAccountDetailsResponsePlanInfoCredits.md +9 -0
- package/docs/SubAccountDetailsResponsePlanInfoCreditsEmails.md +9 -0
- package/docs/SubAccountDetailsResponsePlanInfoFeatures.md +10 -0
- package/docs/SubAccountDetailsResponsePlanInfoFeaturesInbox.md +9 -0
- package/docs/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md +9 -0
- package/docs/SubAccountDetailsResponsePlanInfoFeaturesUsers.md +9 -0
- package/docs/SubAccountUpdatePlanRequest.md +9 -0
- package/docs/SubAccountUpdatePlanRequestCredits.md +8 -0
- package/docs/SubAccountUpdatePlanRequestFeatures.md +10 -0
- package/docs/SubAccountsResponse.md +9 -0
- package/docs/SubAccountsResponseSubAccounts.md +11 -0
- package/docs/Task.md +13 -0
- package/docs/TaskList.md +8 -0
- package/docs/TaskReminder.md +25 -0
- package/docs/TaskTypes.md +9 -0
- package/docs/TasksApi.md +360 -0
- package/docs/TransactionalEmailsApi.md +1333 -0
- package/docs/TransactionalSMSApi.md +261 -0
- package/docs/TransactionalWhatsAppApi.md +137 -0
- package/docs/UpdateAttribute.md +9 -0
- package/docs/UpdateAttributeEnumeration.md +9 -0
- package/docs/UpdateBatchContacts.md +8 -0
- package/docs/UpdateBatchContactsContacts.md +17 -0
- package/docs/UpdateBatchContactsModel.md +9 -0
- package/docs/UpdateCampaignStatus.md +31 -0
- package/docs/UpdateChild.md +12 -0
- package/docs/UpdateChildAccountStatus.md +11 -0
- package/docs/UpdateChildDomain.md +8 -0
- package/docs/UpdateContact.md +14 -0
- package/docs/UpdateCouponCollection.md +8 -0
- package/docs/UpdateEmailCampaign.md +49 -0
- package/docs/UpdateEmailCampaignRecipients.md +10 -0
- package/docs/UpdateEmailCampaignSender.md +10 -0
- package/docs/UpdateExternalFeed.md +29 -0
- package/docs/UpdateList.md +9 -0
- package/docs/UpdateSender.md +10 -0
- package/docs/UpdateSmsCampaign.md +15 -0
- package/docs/UpdateSmtpTemplate.md +17 -0
- package/docs/UpdateSmtpTemplateSender.md +10 -0
- package/docs/UpdateWebhook.md +52 -0
- package/docs/UpdateWhatsAppCampaign.md +22 -0
- package/docs/UploadImageModel.md +8 -0
- package/docs/UploadImageToGallery.md +9 -0
- package/docs/UserApi.md +112 -0
- package/docs/VariablesItems.md +10 -0
- package/docs/WebhooksApi.md +346 -0
- package/docs/WhatsAppCampaignsApi.md +519 -0
- package/docs/WhatsappCampStats.md +12 -0
- package/docs/WhatsappCampTemplate.md +18 -0
- package/git_push.sh +52 -0
- package/mocha.opts +1 -0
- package/package.json +35 -0
- package/src/ApiClient.js +601 -0
- package/src/api/AccountApi.js +154 -0
- package/src/api/CompaniesApi.js +431 -0
- package/src/api/ContactsApi.js +1683 -0
- package/src/api/ConversationsApi.js +529 -0
- package/src/api/CouponsApi.js +317 -0
- package/src/api/DealsApi.js +527 -0
- package/src/api/DomainsApi.js +297 -0
- package/src/api/EcommerceApi.js +656 -0
- package/src/api/EmailCampaignsApi.js +781 -0
- package/src/api/ExternalFeedsApi.js +340 -0
- package/src/api/FilesApi.js +336 -0
- package/src/api/InboundParsingApi.js +225 -0
- package/src/api/MasterAccountApi.js +537 -0
- package/src/api/NotesApi.js +330 -0
- package/src/api/ProcessApi.js +159 -0
- package/src/api/ResellerApi.js +941 -0
- package/src/api/SMSCampaignsApi.js +612 -0
- package/src/api/SendersApi.js +410 -0
- package/src/api/TasksApi.js +391 -0
- package/src/api/TransactionalEmailsApi.js +1318 -0
- package/src/api/TransactionalSMSApi.js +295 -0
- package/src/api/TransactionalWhatsAppApi.js +177 -0
- package/src/api/UserApi.js +147 -0
- package/src/api/WebhooksApi.js +367 -0
- package/src/api/WhatsAppCampaignsApi.js +527 -0
- package/src/index.js +1833 -0
- package/src/model/AbTestCampaignResult.js +185 -0
- package/src/model/AbTestCampaignResultClickedLinks.js +83 -0
- package/src/model/AbTestCampaignResultStatistics.js +119 -0
- package/src/model/AbTestVersionClicks.js +69 -0
- package/src/model/AbTestVersionClicksInner.js +95 -0
- package/src/model/AbTestVersionStats.js +86 -0
- package/src/model/AddChildDomain.js +73 -0
- package/src/model/AddContactToList.js +81 -0
- package/src/model/AddCredits.js +81 -0
- package/src/model/AuthenticateDomainModel.js +85 -0
- package/src/model/BlockDomain.js +75 -0
- package/src/model/Body.js +91 -0
- package/src/model/Body1.js +89 -0
- package/src/model/Body10.js +101 -0
- package/src/model/Body11.js +75 -0
- package/src/model/Body12.js +97 -0
- package/src/model/Body2.js +97 -0
- package/src/model/Body3.js +83 -0
- package/src/model/Body4.js +81 -0
- package/src/model/Body5.js +97 -0
- package/src/model/Body6.js +158 -0
- package/src/model/Body7.js +145 -0
- package/src/model/Body8.js +117 -0
- package/src/model/Body9.js +75 -0
- package/src/model/BodyVariablesItems.js +65 -0
- package/src/model/CompaniesList.js +74 -0
- package/src/model/Company.js +98 -0
- package/src/model/CompanyAttributes.js +69 -0
- package/src/model/CompanyAttributesInner.js +101 -0
- package/src/model/ComponentItems.js +79 -0
- package/src/model/ConversationsMessage.js +165 -0
- package/src/model/ConversationsMessageFile.js +104 -0
- package/src/model/ConversationsMessageFileImageInfo.js +90 -0
- package/src/model/CreateApiKeyRequest.js +83 -0
- package/src/model/CreateApiKeyResponse.js +81 -0
- package/src/model/CreateAttribute.js +141 -0
- package/src/model/CreateAttributeEnumeration.js +85 -0
- package/src/model/CreateCategoryModel.js +73 -0
- package/src/model/CreateChild.js +167 -0
- package/src/model/CreateContact.js +130 -0
- package/src/model/CreateCouponCollection.js +85 -0
- package/src/model/CreateCoupons.js +84 -0
- package/src/model/CreateDoiContact.js +121 -0
- package/src/model/CreateDomain.js +75 -0
- package/src/model/CreateDomainModel.js +98 -0
- package/src/model/CreateDomainModelDnsRecords.js +79 -0
- package/src/model/CreateDomainModelDnsRecordsDkimRecord.js +93 -0
- package/src/model/CreateEmailCampaign.js +339 -0
- package/src/model/CreateEmailCampaignRecipients.js +90 -0
- package/src/model/CreateEmailCampaignSender.js +92 -0
- package/src/model/CreateExternalFeed.js +169 -0
- package/src/model/CreateList.js +85 -0
- package/src/model/CreateModel.js +75 -0
- package/src/model/CreateProductModel.js +73 -0
- package/src/model/CreateReseller.js +83 -0
- package/src/model/CreateSender.js +93 -0
- package/src/model/CreateSenderIps.js +93 -0
- package/src/model/CreateSenderModel.js +91 -0
- package/src/model/CreateSmsCampaign.js +135 -0
- package/src/model/CreateSmsCampaignRecipients.js +83 -0
- package/src/model/CreateSmtpEmail.js +80 -0
- package/src/model/CreateSmtpTemplate.js +150 -0
- package/src/model/CreateSmtpTemplateSender.js +90 -0
- package/src/model/CreateSubAccount.js +145 -0
- package/src/model/CreateSubAccountResponse.js +75 -0
- package/src/model/CreateUpdateBatchCategory.js +83 -0
- package/src/model/CreateUpdateBatchCategoryModel.js +81 -0
- package/src/model/CreateUpdateBatchProducts.js +83 -0
- package/src/model/CreateUpdateBatchProductsModel.js +81 -0
- package/src/model/CreateUpdateCategories.js +99 -0
- package/src/model/CreateUpdateCategory.js +108 -0
- package/src/model/CreateUpdateContactModel.js +73 -0
- package/src/model/CreateUpdateFolder.js +73 -0
- package/src/model/CreateUpdateProduct.js +158 -0
- package/src/model/CreateUpdateProducts.js +149 -0
- package/src/model/CreateWebhook.js +246 -0
- package/src/model/CreateWhatsAppCampaign.js +104 -0
- package/src/model/CreateWhatsAppCampaignRecipients.js +90 -0
- package/src/model/CreateWhatsAppTemplate.js +141 -0
- package/src/model/CreatedBatchId.js +75 -0
- package/src/model/CreatedProcessId.js +75 -0
- package/src/model/Deal.js +98 -0
- package/src/model/DealAttributes.js +69 -0
- package/src/model/DealAttributesInner.js +101 -0
- package/src/model/DealsList.js +74 -0
- package/src/model/DeleteHardbounces.js +89 -0
- package/src/model/EmailExportRecipients.js +139 -0
- package/src/model/ErrorModel.js +189 -0
- package/src/model/ExportWebhooksHistory.js +251 -0
- package/src/model/FileData.js +122 -0
- package/src/model/FileDownloadableLink.js +75 -0
- package/src/model/FileList.js +69 -0
- package/src/model/GetAccount.js +101 -0
- package/src/model/GetAccountActivity.js +73 -0
- package/src/model/GetAccountActivityLogs.js +115 -0
- package/src/model/GetAccountMarketingAutomation.js +83 -0
- package/src/model/GetAccountPlan.js +171 -0
- package/src/model/GetAccountRelay.js +85 -0
- package/src/model/GetAccountRelayData.js +96 -0
- package/src/model/GetAggregatedReport.js +169 -0
- package/src/model/GetAllExternalFeeds.js +80 -0
- package/src/model/GetAllExternalFeedsFeeds.js +205 -0
- package/src/model/GetAttributes.js +75 -0
- package/src/model/GetAttributesAttributes.js +185 -0
- package/src/model/GetAttributesEnumeration.js +85 -0
- package/src/model/GetBlockedDomains.js +76 -0
- package/src/model/GetCampaignOverview.js +249 -0
- package/src/model/GetCampaignRecipients.js +83 -0
- package/src/model/GetCampaignStats.js +215 -0
- package/src/model/GetCategories.js +84 -0
- package/src/model/GetCategoryDetails.js +121 -0
- package/src/model/GetChildAccountCreationStatus.js +75 -0
- package/src/model/GetChildDomain.js +81 -0
- package/src/model/GetChildDomains.js +68 -0
- package/src/model/GetChildInfo.js +113 -0
- package/src/model/GetChildInfoApiKeys.js +82 -0
- package/src/model/GetChildInfoApiKeysV2.js +85 -0
- package/src/model/GetChildInfoApiKeysV3.js +85 -0
- package/src/model/GetChildInfoCredits.js +82 -0
- package/src/model/GetChildInfoStatistics.js +90 -0
- package/src/model/GetChildrenList.js +81 -0
- package/src/model/GetClient.js +105 -0
- package/src/model/GetContactCampaignStats.js +129 -0
- package/src/model/GetContactCampaignStatsClicked.js +84 -0
- package/src/model/GetContactCampaignStatsOpened.js +105 -0
- package/src/model/GetContactCampaignStatsTransacAttributes.js +95 -0
- package/src/model/GetContactCampaignStatsUnsubscriptions.js +85 -0
- package/src/model/GetContactDetails.js +151 -0
- package/src/model/GetContacts.js +84 -0
- package/src/model/GetCouponCollection.js +125 -0
- package/src/model/GetDeviceBrowserStats.js +105 -0
- package/src/model/GetDomainConfigurationModel.js +104 -0
- package/src/model/GetDomainsList.js +73 -0
- package/src/model/GetDomainsListDomains.js +113 -0
- package/src/model/GetEmailCampaign.js +100 -0
- package/src/model/GetEmailCampaigns.js +80 -0
- package/src/model/GetEmailEventReport.js +72 -0
- package/src/model/GetEmailEventReportEvents.js +253 -0
- package/src/model/GetExtendedCampaignOverview.js +217 -0
- package/src/model/GetExtendedCampaignOverviewSender.js +89 -0
- package/src/model/GetExtendedCampaignStats.js +143 -0
- package/src/model/GetExtendedCampaignStatsGlobalStats.js +66 -0
- package/src/model/GetExtendedClient.js +83 -0
- package/src/model/GetExtendedClientAddress.js +106 -0
- package/src/model/GetExtendedContactDetails.js +87 -0
- package/src/model/GetExtendedContactDetailsStatistics.js +137 -0
- package/src/model/GetExtendedContactDetailsStatisticsClicked.js +85 -0
- package/src/model/GetExtendedContactDetailsStatisticsLinks.js +105 -0
- package/src/model/GetExtendedContactDetailsStatisticsMessagesSent.js +85 -0
- package/src/model/GetExtendedContactDetailsStatisticsOpened.js +105 -0
- package/src/model/GetExtendedContactDetailsStatisticsUnsubscriptions.js +86 -0
- package/src/model/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.js +83 -0
- package/src/model/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.js +93 -0
- package/src/model/GetExtendedList.js +110 -0
- package/src/model/GetExtendedListCampaignStats.js +84 -0
- package/src/model/GetExternalFeedByUUID.js +205 -0
- package/src/model/GetExternalFeedByUUIDHeaders.js +81 -0
- package/src/model/GetFolder.js +115 -0
- package/src/model/GetFolderLists.js +80 -0
- package/src/model/GetFolders.js +80 -0
- package/src/model/GetInboundEmailEvents.js +72 -0
- package/src/model/GetInboundEmailEventsByUuid.js +129 -0
- package/src/model/GetInboundEmailEventsByUuidAttachments.js +97 -0
- package/src/model/GetInboundEmailEventsByUuidLogs.js +113 -0
- package/src/model/GetInboundEmailEventsEvents.js +105 -0
- package/src/model/GetInvitedUsersList.js +73 -0
- package/src/model/GetInvitedUsersListFeatureAccess.js +90 -0
- package/src/model/GetInvitedUsersListUsers.js +104 -0
- package/src/model/GetIp.js +105 -0
- package/src/model/GetIpFromSender.js +105 -0
- package/src/model/GetIps.js +75 -0
- package/src/model/GetIpsFromSender.js +75 -0
- package/src/model/GetList.js +115 -0
- package/src/model/GetLists.js +81 -0
- package/src/model/GetProcess.js +129 -0
- package/src/model/GetProcesses.js +81 -0
- package/src/model/GetProductDetails.js +197 -0
- package/src/model/GetProducts.js +84 -0
- package/src/model/GetReports.js +72 -0
- package/src/model/GetReportsReports.js +195 -0
- package/src/model/GetScheduledEmailByBatchId.js +80 -0
- package/src/model/GetScheduledEmailByBatchIdBatches.js +127 -0
- package/src/model/GetScheduledEmailByMessageId.js +127 -0
- package/src/model/GetSegments.js +80 -0
- package/src/model/GetSegmentsSegments.js +97 -0
- package/src/model/GetSendersList.js +73 -0
- package/src/model/GetSendersListIps.js +95 -0
- package/src/model/GetSendersListSenders.js +113 -0
- package/src/model/GetSharedTemplateUrl.js +75 -0
- package/src/model/GetSmsCampaign.js +95 -0
- package/src/model/GetSmsCampaignOverview.js +187 -0
- package/src/model/GetSmsCampaignRecipients.js +65 -0
- package/src/model/GetSmsCampaignStats.js +135 -0
- package/src/model/GetSmsCampaigns.js +80 -0
- package/src/model/GetSmsEventReport.js +72 -0
- package/src/model/GetSmsEventReportEvents.js +188 -0
- package/src/model/GetSmtpTemplateOverview.js +192 -0
- package/src/model/GetSmtpTemplateOverviewSender.js +89 -0
- package/src/model/GetSmtpTemplates.js +80 -0
- package/src/model/GetSsoToken.js +75 -0
- package/src/model/GetStatsByBrowser.js +68 -0
- package/src/model/GetStatsByDevice.js +97 -0
- package/src/model/GetStatsByDomain.js +68 -0
- package/src/model/GetTransacAggregatedSmsReport.js +145 -0
- package/src/model/GetTransacBlockedContacts.js +80 -0
- package/src/model/GetTransacBlockedContactsContacts.js +104 -0
- package/src/model/GetTransacBlockedContactsReason.js +126 -0
- package/src/model/GetTransacEmailContent.js +133 -0
- package/src/model/GetTransacEmailContentEvents.js +85 -0
- package/src/model/GetTransacEmailsList.js +80 -0
- package/src/model/GetTransacEmailsListTransactionalEmails.js +139 -0
- package/src/model/GetTransacSmsReport.js +72 -0
- package/src/model/GetTransacSmsReportReports.js +145 -0
- package/src/model/GetUserPermission.js +96 -0
- package/src/model/GetUserPermissionPrivileges.js +83 -0
- package/src/model/GetWATemplates.js +84 -0
- package/src/model/GetWATemplatesTemplates.js +143 -0
- package/src/model/GetWebhook.js +154 -0
- package/src/model/GetWebhooks.js +74 -0
- package/src/model/GetWhatsAppConfig.js +165 -0
- package/src/model/GetWhatsappCampaignOverview.js +205 -0
- package/src/model/GetWhatsappCampaigns.js +80 -0
- package/src/model/GetWhatsappCampaignsCampaigns.js +222 -0
- package/src/model/GetWhatsappEventReport.js +72 -0
- package/src/model/GetWhatsappEventReportEvents.js +189 -0
- package/src/model/InlineResponse200.js +76 -0
- package/src/model/InlineResponse2001.js +95 -0
- package/src/model/InlineResponse201.js +76 -0
- package/src/model/InlineResponse2011.js +76 -0
- package/src/model/InlineResponse2012.js +75 -0
- package/src/model/InlineResponse2013.js +75 -0
- package/src/model/InlineResponse2014.js +75 -0
- package/src/model/ManageIp.js +73 -0
- package/src/model/MasterDetailsResponse.js +119 -0
- package/src/model/MasterDetailsResponseBillingInfo.js +96 -0
- package/src/model/MasterDetailsResponseBillingInfoAddress.js +106 -0
- package/src/model/MasterDetailsResponseBillingInfoName.js +82 -0
- package/src/model/MasterDetailsResponsePlanInfo.js +134 -0
- package/src/model/MasterDetailsResponsePlanInfoFeatures.js +105 -0
- package/src/model/Note.js +124 -0
- package/src/model/NoteData.js +100 -0
- package/src/model/NoteId.js +74 -0
- package/src/model/NoteList.js +69 -0
- package/src/model/Order.js +147 -0
- package/src/model/OrderBatch.js +83 -0
- package/src/model/OrderBilling.js +122 -0
- package/src/model/OrderProducts.js +104 -0
- package/src/model/Otp.js +73 -0
- package/src/model/Pipeline.js +90 -0
- package/src/model/PipelineStage.js +82 -0
- package/src/model/Pipelines.js +69 -0
- package/src/model/PostContactInfo.js +74 -0
- package/src/model/PostContactInfoContacts.js +95 -0
- package/src/model/PostSendFailed.js +106 -0
- package/src/model/PostSendSmsTestFailed.js +99 -0
- package/src/model/RemainingCreditModel.js +83 -0
- package/src/model/RemainingCreditModelChild.js +86 -0
- package/src/model/RemainingCreditModelReseller.js +85 -0
- package/src/model/RemoveContactFromList.js +89 -0
- package/src/model/RemoveCredits.js +81 -0
- package/src/model/RequestContactExport.js +90 -0
- package/src/model/RequestContactExportCustomContactFilter.js +222 -0
- package/src/model/RequestContactImport.js +148 -0
- package/src/model/RequestContactImportNewList.js +82 -0
- package/src/model/RequestSmsRecipientExport.js +127 -0
- package/src/model/ScheduleSmtpEmail.js +88 -0
- package/src/model/SendReport.js +127 -0
- package/src/model/SendReportEmail.js +86 -0
- package/src/model/SendSms.js +107 -0
- package/src/model/SendSmtpEmail.js +191 -0
- package/src/model/SendSmtpEmailAttachment.js +89 -0
- package/src/model/SendSmtpEmailBcc.js +83 -0
- package/src/model/SendSmtpEmailCc.js +83 -0
- package/src/model/SendSmtpEmailMessageVersions.js +114 -0
- package/src/model/SendSmtpEmailReplyTo.js +84 -0
- package/src/model/SendSmtpEmailReplyTo1.js +84 -0
- package/src/model/SendSmtpEmailSender.js +90 -0
- package/src/model/SendSmtpEmailTo.js +83 -0
- package/src/model/SendSmtpEmailTo1.js +83 -0
- package/src/model/SendTestEmail.js +73 -0
- package/src/model/SendTestSms.js +73 -0
- package/src/model/SendTransacSms.js +157 -0
- package/src/model/SendWhatsappMessage.js +101 -0
- package/src/model/SsoTokenRequest.js +147 -0
- package/src/model/SubAccountDetailsResponse.js +96 -0
- package/src/model/SubAccountDetailsResponsePlanInfo.js +88 -0
- package/src/model/SubAccountDetailsResponsePlanInfoCredits.js +81 -0
- package/src/model/SubAccountDetailsResponsePlanInfoCreditsEmails.js +82 -0
- package/src/model/SubAccountDetailsResponsePlanInfoFeatures.js +87 -0
- package/src/model/SubAccountDetailsResponsePlanInfoFeaturesInbox.js +82 -0
- package/src/model/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.js +82 -0
- package/src/model/SubAccountDetailsResponsePlanInfoFeaturesUsers.js +82 -0
- package/src/model/SubAccountUpdatePlanRequest.js +80 -0
- package/src/model/SubAccountUpdatePlanRequestCredits.js +74 -0
- package/src/model/SubAccountUpdatePlanRequestFeatures.js +90 -0
- package/src/model/SubAccountsResponse.js +80 -0
- package/src/model/SubAccountsResponseSubAccounts.js +105 -0
- package/src/model/Task.js +118 -0
- package/src/model/TaskList.js +74 -0
- package/src/model/TaskReminder.js +128 -0
- package/src/model/TaskTypes.js +82 -0
- package/src/model/UpdateAttribute.js +81 -0
- package/src/model/UpdateAttributeEnumeration.js +85 -0
- package/src/model/UpdateBatchContacts.js +73 -0
- package/src/model/UpdateBatchContactsContacts.js +145 -0
- package/src/model/UpdateBatchContactsModel.js +79 -0
- package/src/model/UpdateCampaignStatus.js +130 -0
- package/src/model/UpdateChild.js +105 -0
- package/src/model/UpdateChildAccountStatus.js +97 -0
- package/src/model/UpdateChildDomain.js +73 -0
- package/src/model/UpdateContact.js +121 -0
- package/src/model/UpdateCouponCollection.js +75 -0
- package/src/model/UpdateEmailCampaign.js +335 -0
- package/src/model/UpdateEmailCampaignRecipients.js +90 -0
- package/src/model/UpdateEmailCampaignSender.js +90 -0
- package/src/model/UpdateExternalFeed.js +164 -0
- package/src/model/UpdateList.js +81 -0
- package/src/model/UpdateSender.js +89 -0
- package/src/model/UpdateSmsCampaign.js +129 -0
- package/src/model/UpdateSmtpTemplate.js +144 -0
- package/src/model/UpdateSmtpTemplateSender.js +90 -0
- package/src/model/UpdateWebhook.js +207 -0
- package/src/model/UpdateWhatsAppCampaign.js +117 -0
- package/src/model/UploadImageModel.js +75 -0
- package/src/model/UploadImageToGallery.js +83 -0
- package/src/model/VariablesItems.js +86 -0
- package/src/model/WhatsappCampStats.js +110 -0
- package/src/model/WhatsappCampTemplate.js +149 -0
- package/test/api/AccountApi.spec.js +157 -0
- package/test/api/CompaniesApi.spec.js +273 -0
- package/test/api/ContactsApi.spec.js +1278 -0
- package/test/api/ConversationsApi.spec.js +430 -0
- package/test/api/CouponsApi.spec.js +176 -0
- package/test/api/DealsApi.spec.js +300 -0
- package/test/api/DomainsApi.spec.js +210 -0
- package/test/api/EcommerceApi.spec.js +423 -0
- package/test/api/EmailCampaignsApi.spec.js +512 -0
- package/test/api/ExternalFeedsApi.spec.js +249 -0
- package/test/api/FilesApi.spec.js +176 -0
- package/test/api/InboundParsingApi.spec.js +168 -0
- package/test/api/MasterAccountApi.spec.js +372 -0
- package/test/api/NotesApi.spec.js +181 -0
- package/test/api/ProcessApi.spec.js +111 -0
- package/test/api/ResellerApi.spec.js +467 -0
- package/test/api/SMSCampaignsApi.spec.js +294 -0
- package/test/api/SendersApi.spec.js +264 -0
- package/test/api/TasksApi.spec.js +277 -0
- package/test/api/TransactionalEmailsApi.spec.js +870 -0
- package/test/api/TransactionalSMSApi.spec.js +228 -0
- package/test/api/TransactionalWhatsAppApi.spec.js +120 -0
- package/test/api/UserApi.spec.js +128 -0
- package/test/api/WebhooksApi.spec.js +209 -0
- package/test/api/WhatsAppCampaignsApi.spec.js +413 -0
- package/test/assert-equals.js +81 -0
- package/test/model/AbTestCampaignResult.spec.js +95 -0
- package/test/model/AbTestCampaignResultClickedLinks.spec.js +59 -0
- package/test/model/AbTestCampaignResultStatistics.spec.js +83 -0
- package/test/model/AbTestVersionClicks.spec.js +47 -0
- package/test/model/AbTestVersionClicksInner.spec.js +65 -0
- package/test/model/AbTestVersionStats.spec.js +59 -0
- package/test/model/AddChildDomain.spec.js +53 -0
- package/test/model/AddContactToList.spec.js +59 -0
- package/test/model/AddCredits.spec.js +59 -0
- package/test/model/AuthenticateDomainModel.spec.js +59 -0
- package/test/model/BlockDomain.spec.js +53 -0
- package/test/model/Body.spec.js +65 -0
- package/test/model/Body1.spec.js +65 -0
- package/test/model/Body10.spec.js +71 -0
- package/test/model/Body11.spec.js +53 -0
- package/test/model/Body12.spec.js +71 -0
- package/test/model/Body2.spec.js +71 -0
- package/test/model/Body3.spec.js +59 -0
- package/test/model/Body4.spec.js +59 -0
- package/test/model/Body5.spec.js +71 -0
- package/test/model/Body6.spec.js +113 -0
- package/test/model/Body7.spec.js +107 -0
- package/test/model/Body8.spec.js +83 -0
- package/test/model/Body9.spec.js +53 -0
- package/test/model/BodyVariablesItems.spec.js +47 -0
- package/test/model/CompaniesList.spec.js +53 -0
- package/test/model/Company.spec.js +71 -0
- package/test/model/CompanyAttributes.spec.js +47 -0
- package/test/model/CompanyAttributesInner.spec.js +77 -0
- package/test/model/ComponentItems.spec.js +59 -0
- package/test/model/ConversationsMessage.spec.js +107 -0
- package/test/model/ConversationsMessageFile.spec.js +77 -0
- package/test/model/ConversationsMessageFileImageInfo.spec.js +65 -0
- package/test/model/CreateApiKeyRequest.spec.js +59 -0
- package/test/model/CreateApiKeyResponse.spec.js +59 -0
- package/test/model/CreateAttribute.spec.js +71 -0
- package/test/model/CreateAttributeEnumeration.spec.js +59 -0
- package/test/model/CreateCategoryModel.spec.js +53 -0
- package/test/model/CreateChild.spec.js +83 -0
- package/test/model/CreateContact.spec.js +95 -0
- package/test/model/CreateCouponCollection.spec.js +59 -0
- package/test/model/CreateCoupons.spec.js +59 -0
- package/test/model/CreateDoiContact.spec.js +83 -0
- package/test/model/CreateDomain.spec.js +53 -0
- package/test/model/CreateDomainModel.spec.js +71 -0
- package/test/model/CreateDomainModelDnsRecords.spec.js +59 -0
- package/test/model/CreateDomainModelDnsRecordsDkimRecord.spec.js +71 -0
- package/test/model/CreateEmailCampaign.spec.js +233 -0
- package/test/model/CreateEmailCampaignRecipients.spec.js +65 -0
- package/test/model/CreateEmailCampaignSender.spec.js +65 -0
- package/test/model/CreateExternalFeed.spec.js +101 -0
- package/test/model/CreateList.spec.js +59 -0
- package/test/model/CreateModel.spec.js +53 -0
- package/test/model/CreateProductModel.spec.js +53 -0
- package/test/model/CreateReseller.spec.js +59 -0
- package/test/model/CreateSender.spec.js +65 -0
- package/test/model/CreateSenderIps.spec.js +65 -0
- package/test/model/CreateSenderModel.spec.js +65 -0
- package/test/model/CreateSmsCampaign.spec.js +95 -0
- package/test/model/CreateSmsCampaignRecipients.spec.js +59 -0
- package/test/model/CreateSmtpEmail.spec.js +59 -0
- package/test/model/CreateSmtpTemplate.spec.js +107 -0
- package/test/model/CreateSmtpTemplateSender.spec.js +65 -0
- package/test/model/CreateSubAccount.spec.js +71 -0
- package/test/model/CreateSubAccountResponse.spec.js +53 -0
- package/test/model/CreateUpdateBatchCategory.spec.js +59 -0
- package/test/model/CreateUpdateBatchCategoryModel.spec.js +59 -0
- package/test/model/CreateUpdateBatchProducts.spec.js +59 -0
- package/test/model/CreateUpdateBatchProductsModel.spec.js +59 -0
- package/test/model/CreateUpdateCategories.spec.js +71 -0
- package/test/model/CreateUpdateCategory.spec.js +77 -0
- package/test/model/CreateUpdateContactModel.spec.js +53 -0
- package/test/model/CreateUpdateFolder.spec.js +53 -0
- package/test/model/CreateUpdateProduct.spec.js +113 -0
- package/test/model/CreateUpdateProducts.spec.js +107 -0
- package/test/model/CreateWebhook.spec.js +77 -0
- package/test/model/CreateWhatsAppCampaign.spec.js +71 -0
- package/test/model/CreateWhatsAppCampaignRecipients.spec.js +65 -0
- package/test/model/CreateWhatsAppTemplate.spec.js +83 -0
- package/test/model/CreatedBatchId.spec.js +53 -0
- package/test/model/CreatedProcessId.spec.js +53 -0
- package/test/model/Deal.spec.js +71 -0
- package/test/model/DealAttributes.spec.js +47 -0
- package/test/model/DealAttributesInner.spec.js +77 -0
- package/test/model/DealsList.spec.js +53 -0
- package/test/model/DeleteHardbounces.spec.js +65 -0
- package/test/model/EmailExportRecipients.spec.js +59 -0
- package/test/model/ErrorModel.spec.js +59 -0
- package/test/model/ExportWebhooksHistory.spec.js +101 -0
- package/test/model/FileData.spec.js +89 -0
- package/test/model/FileDownloadableLink.spec.js +53 -0
- package/test/model/FileList.spec.js +47 -0
- package/test/model/GetAccount.spec.js +65 -0
- package/test/model/GetAccountActivity.spec.js +53 -0
- package/test/model/GetAccountActivityLogs.spec.js +77 -0
- package/test/model/GetAccountMarketingAutomation.spec.js +59 -0
- package/test/model/GetAccountPlan.spec.js +83 -0
- package/test/model/GetAccountRelay.spec.js +59 -0
- package/test/model/GetAccountRelayData.spec.js +65 -0
- package/test/model/GetAggregatedReport.spec.js +125 -0
- package/test/model/GetAllExternalFeeds.spec.js +59 -0
- package/test/model/GetAllExternalFeedsFeeds.spec.js +119 -0
- package/test/model/GetAttributes.spec.js +53 -0
- package/test/model/GetAttributesAttributes.spec.js +77 -0
- package/test/model/GetAttributesEnumeration.spec.js +59 -0
- package/test/model/GetBlockedDomains.spec.js +53 -0
- package/test/model/GetCampaignOverview.spec.js +131 -0
- package/test/model/GetCampaignRecipients.spec.js +59 -0
- package/test/model/GetCampaignStats.spec.js +143 -0
- package/test/model/GetCategories.spec.js +59 -0
- package/test/model/GetCategoryDetails.spec.js +83 -0
- package/test/model/GetChildAccountCreationStatus.spec.js +53 -0
- package/test/model/GetChildDomain.spec.js +59 -0
- package/test/model/GetChildDomains.spec.js +47 -0
- package/test/model/GetChildInfo.spec.js +77 -0
- package/test/model/GetChildInfoApiKeys.spec.js +59 -0
- package/test/model/GetChildInfoApiKeysV2.spec.js +59 -0
- package/test/model/GetChildInfoApiKeysV3.spec.js +59 -0
- package/test/model/GetChildInfoCredits.spec.js +59 -0
- package/test/model/GetChildInfoStatistics.spec.js +65 -0
- package/test/model/GetChildrenList.spec.js +59 -0
- package/test/model/GetClient.spec.js +71 -0
- package/test/model/GetContactCampaignStats.spec.js +101 -0
- package/test/model/GetContactCampaignStatsClicked.spec.js +59 -0
- package/test/model/GetContactCampaignStatsOpened.spec.js +71 -0
- package/test/model/GetContactCampaignStatsTransacAttributes.spec.js +65 -0
- package/test/model/GetContactCampaignStatsUnsubscriptions.spec.js +59 -0
- package/test/model/GetContactDetails.spec.js +101 -0
- package/test/model/GetContacts.spec.js +59 -0
- package/test/model/GetCouponCollection.spec.js +83 -0
- package/test/model/GetDeviceBrowserStats.spec.js +71 -0
- package/test/model/GetDomainConfigurationModel.spec.js +71 -0
- package/test/model/GetDomainsList.spec.js +53 -0
- package/test/model/GetDomainsListDomains.spec.js +77 -0
- package/test/model/GetEmailCampaign.spec.js +59 -0
- package/test/model/GetEmailCampaigns.spec.js +59 -0
- package/test/model/GetEmailEventReport.spec.js +53 -0
- package/test/model/GetEmailEventReportEvents.spec.js +113 -0
- package/test/model/GetExtendedCampaignOverview.spec.js +143 -0
- package/test/model/GetExtendedCampaignOverviewSender.spec.js +65 -0
- package/test/model/GetExtendedCampaignStats.spec.js +95 -0
- package/test/model/GetExtendedCampaignStatsGlobalStats.spec.js +47 -0
- package/test/model/GetExtendedClient.spec.js +53 -0
- package/test/model/GetExtendedClientAddress.spec.js +71 -0
- package/test/model/GetExtendedContactDetails.spec.js +53 -0
- package/test/model/GetExtendedContactDetailsStatistics.spec.js +101 -0
- package/test/model/GetExtendedContactDetailsStatisticsClicked.spec.js +59 -0
- package/test/model/GetExtendedContactDetailsStatisticsLinks.spec.js +71 -0
- package/test/model/GetExtendedContactDetailsStatisticsMessagesSent.spec.js +59 -0
- package/test/model/GetExtendedContactDetailsStatisticsOpened.spec.js +71 -0
- package/test/model/GetExtendedContactDetailsStatisticsUnsubscriptions.spec.js +59 -0
- package/test/model/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.spec.js +59 -0
- package/test/model/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.spec.js +65 -0
- package/test/model/GetExtendedList.spec.js +71 -0
- package/test/model/GetExtendedListCampaignStats.spec.js +59 -0
- package/test/model/GetExternalFeedByUUID.spec.js +119 -0
- package/test/model/GetExternalFeedByUUIDHeaders.spec.js +59 -0
- package/test/model/GetFolder.spec.js +77 -0
- package/test/model/GetFolderLists.spec.js +59 -0
- package/test/model/GetFolders.spec.js +59 -0
- package/test/model/GetInboundEmailEvents.spec.js +53 -0
- package/test/model/GetInboundEmailEventsByUuid.spec.js +95 -0
- package/test/model/GetInboundEmailEventsByUuidAttachments.spec.js +71 -0
- package/test/model/GetInboundEmailEventsByUuidLogs.spec.js +59 -0
- package/test/model/GetInboundEmailEventsEvents.spec.js +71 -0
- package/test/model/GetInvitedUsersList.spec.js +53 -0
- package/test/model/GetInvitedUsersListFeatureAccess.spec.js +65 -0
- package/test/model/GetInvitedUsersListUsers.spec.js +71 -0
- package/test/model/GetIp.spec.js +71 -0
- package/test/model/GetIpFromSender.spec.js +71 -0
- package/test/model/GetIps.spec.js +53 -0
- package/test/model/GetIpsFromSender.spec.js +53 -0
- package/test/model/GetList.spec.js +77 -0
- package/test/model/GetLists.spec.js +59 -0
- package/test/model/GetProcess.spec.js +71 -0
- package/test/model/GetProcesses.spec.js +59 -0
- package/test/model/GetProductDetails.spec.js +137 -0
- package/test/model/GetProducts.spec.js +59 -0
- package/test/model/GetReports.spec.js +53 -0
- package/test/model/GetReportsReports.spec.js +125 -0
- package/test/model/GetScheduledEmailByBatchId.spec.js +59 -0
- package/test/model/GetScheduledEmailByBatchIdBatches.spec.js +65 -0
- package/test/model/GetScheduledEmailByMessageId.spec.js +65 -0
- package/test/model/GetSegments.spec.js +59 -0
- package/test/model/GetSegmentsSegments.spec.js +71 -0
- package/test/model/GetSendersList.spec.js +53 -0
- package/test/model/GetSendersListIps.spec.js +65 -0
- package/test/model/GetSendersListSenders.spec.js +77 -0
- package/test/model/GetSharedTemplateUrl.spec.js +53 -0
- package/test/model/GetSmsCampaign.spec.js +59 -0
- package/test/model/GetSmsCampaignOverview.spec.js +95 -0
- package/test/model/GetSmsCampaignRecipients.spec.js +47 -0
- package/test/model/GetSmsCampaignStats.spec.js +89 -0
- package/test/model/GetSmsCampaigns.spec.js +59 -0
- package/test/model/GetSmsEventReport.spec.js +53 -0
- package/test/model/GetSmsEventReportEvents.spec.js +89 -0
- package/test/model/GetSmtpTemplateOverview.spec.js +125 -0
- package/test/model/GetSmtpTemplateOverviewSender.spec.js +65 -0
- package/test/model/GetSmtpTemplates.spec.js +59 -0
- package/test/model/GetSsoToken.spec.js +53 -0
- package/test/model/GetStatsByBrowser.spec.js +47 -0
- package/test/model/GetStatsByDevice.spec.js +71 -0
- package/test/model/GetStatsByDomain.spec.js +47 -0
- package/test/model/GetTransacAggregatedSmsReport.spec.js +107 -0
- package/test/model/GetTransacBlockedContacts.spec.js +59 -0
- package/test/model/GetTransacBlockedContactsContacts.spec.js +71 -0
- package/test/model/GetTransacBlockedContactsReason.spec.js +59 -0
- package/test/model/GetTransacEmailContent.spec.js +89 -0
- package/test/model/GetTransacEmailContentEvents.spec.js +59 -0
- package/test/model/GetTransacEmailsList.spec.js +59 -0
- package/test/model/GetTransacEmailsListTransactionalEmails.spec.js +95 -0
- package/test/model/GetTransacSmsReport.spec.js +53 -0
- package/test/model/GetTransacSmsReportReports.spec.js +107 -0
- package/test/model/GetUserPermission.spec.js +65 -0
- package/test/model/GetUserPermissionPrivileges.spec.js +59 -0
- package/test/model/GetWATemplates.spec.js +59 -0
- package/test/model/GetWATemplatesTemplates.spec.js +95 -0
- package/test/model/GetWebhook.spec.js +89 -0
- package/test/model/GetWebhooks.spec.js +53 -0
- package/test/model/GetWhatsAppConfig.spec.js +83 -0
- package/test/model/GetWhatsappCampaignOverview.spec.js +101 -0
- package/test/model/GetWhatsappCampaigns.spec.js +59 -0
- package/test/model/GetWhatsappCampaignsCampaigns.spec.js +113 -0
- package/test/model/GetWhatsappEventReport.spec.js +53 -0
- package/test/model/GetWhatsappEventReportEvents.spec.js +95 -0
- package/test/model/InlineResponse200.spec.js +53 -0
- package/test/model/InlineResponse2001.spec.js +65 -0
- package/test/model/InlineResponse201.spec.js +53 -0
- package/test/model/InlineResponse2011.spec.js +53 -0
- package/test/model/InlineResponse2012.spec.js +53 -0
- package/test/model/InlineResponse2013.spec.js +53 -0
- package/test/model/InlineResponse2014.spec.js +53 -0
- package/test/model/ManageIp.spec.js +53 -0
- package/test/model/MasterDetailsResponse.spec.js +89 -0
- package/test/model/MasterDetailsResponseBillingInfo.spec.js +71 -0
- package/test/model/MasterDetailsResponseBillingInfoAddress.spec.js +77 -0
- package/test/model/MasterDetailsResponseBillingInfoName.spec.js +59 -0
- package/test/model/MasterDetailsResponsePlanInfo.spec.js +83 -0
- package/test/model/MasterDetailsResponsePlanInfoFeatures.spec.js +77 -0
- package/test/model/Note.spec.js +89 -0
- package/test/model/NoteData.spec.js +71 -0
- package/test/model/NoteId.spec.js +53 -0
- package/test/model/NoteList.spec.js +47 -0
- package/test/model/Order.spec.js +101 -0
- package/test/model/OrderBatch.spec.js +59 -0
- package/test/model/OrderBilling.spec.js +89 -0
- package/test/model/OrderProducts.spec.js +71 -0
- package/test/model/Otp.spec.js +53 -0
- package/test/model/Pipeline.spec.js +65 -0
- package/test/model/PipelineStage.spec.js +59 -0
- package/test/model/Pipelines.spec.js +47 -0
- package/test/model/PostContactInfo.spec.js +53 -0
- package/test/model/PostContactInfoContacts.spec.js +71 -0
- package/test/model/PostSendFailed.spec.js +77 -0
- package/test/model/PostSendSmsTestFailed.spec.js +71 -0
- package/test/model/RemainingCreditModel.spec.js +59 -0
- package/test/model/RemainingCreditModelChild.spec.js +59 -0
- package/test/model/RemainingCreditModelReseller.spec.js +59 -0
- package/test/model/RemoveContactFromList.spec.js +65 -0
- package/test/model/RemoveCredits.spec.js +59 -0
- package/test/model/RequestContactExport.spec.js +65 -0
- package/test/model/RequestContactExportCustomContactFilter.spec.js +83 -0
- package/test/model/RequestContactImport.spec.js +107 -0
- package/test/model/RequestContactImportNewList.spec.js +59 -0
- package/test/model/RequestSmsRecipientExport.spec.js +59 -0
- package/test/model/ScheduleSmtpEmail.spec.js +65 -0
- package/test/model/SendReport.spec.js +59 -0
- package/test/model/SendReportEmail.spec.js +59 -0
- package/test/model/SendSms.spec.js +77 -0
- package/test/model/SendSmtpEmail.spec.js +143 -0
- package/test/model/SendSmtpEmailAttachment.spec.js +65 -0
- package/test/model/SendSmtpEmailBcc.spec.js +59 -0
- package/test/model/SendSmtpEmailCc.spec.js +59 -0
- package/test/model/SendSmtpEmailMessageVersions.spec.js +83 -0
- package/test/model/SendSmtpEmailReplyTo.spec.js +59 -0
- package/test/model/SendSmtpEmailReplyTo1.spec.js +59 -0
- package/test/model/SendSmtpEmailSender.spec.js +65 -0
- package/test/model/SendSmtpEmailTo.spec.js +59 -0
- package/test/model/SendSmtpEmailTo1.spec.js +59 -0
- package/test/model/SendTestEmail.spec.js +53 -0
- package/test/model/SendTestSms.spec.js +53 -0
- package/test/model/SendTransacSms.spec.js +95 -0
- package/test/model/SendWhatsappMessage.spec.js +71 -0
- package/test/model/SsoTokenRequest.spec.js +65 -0
- package/test/model/SubAccountDetailsResponse.spec.js +71 -0
- package/test/model/SubAccountDetailsResponsePlanInfo.spec.js +65 -0
- package/test/model/SubAccountDetailsResponsePlanInfoCredits.spec.js +59 -0
- package/test/model/SubAccountDetailsResponsePlanInfoCreditsEmails.spec.js +59 -0
- package/test/model/SubAccountDetailsResponsePlanInfoFeatures.spec.js +65 -0
- package/test/model/SubAccountDetailsResponsePlanInfoFeaturesInbox.spec.js +59 -0
- package/test/model/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.spec.js +59 -0
- package/test/model/SubAccountDetailsResponsePlanInfoFeaturesUsers.spec.js +59 -0
- package/test/model/SubAccountUpdatePlanRequest.spec.js +59 -0
- package/test/model/SubAccountUpdatePlanRequestCredits.spec.js +53 -0
- package/test/model/SubAccountUpdatePlanRequestFeatures.spec.js +65 -0
- package/test/model/SubAccountsResponse.spec.js +59 -0
- package/test/model/SubAccountsResponseSubAccounts.spec.js +71 -0
- package/test/model/Task.spec.js +83 -0
- package/test/model/TaskList.spec.js +53 -0
- package/test/model/TaskReminder.spec.js +65 -0
- package/test/model/TaskTypes.spec.js +59 -0
- package/test/model/UpdateAttribute.spec.js +59 -0
- package/test/model/UpdateAttributeEnumeration.spec.js +59 -0
- package/test/model/UpdateBatchContacts.spec.js +53 -0
- package/test/model/UpdateBatchContactsContacts.spec.js +107 -0
- package/test/model/UpdateBatchContactsModel.spec.js +59 -0
- package/test/model/UpdateCampaignStatus.spec.js +53 -0
- package/test/model/UpdateChild.spec.js +77 -0
- package/test/model/UpdateChildAccountStatus.spec.js +71 -0
- package/test/model/UpdateChildDomain.spec.js +53 -0
- package/test/model/UpdateContact.spec.js +89 -0
- package/test/model/UpdateCouponCollection.spec.js +53 -0
- package/test/model/UpdateEmailCampaign.spec.js +233 -0
- package/test/model/UpdateEmailCampaignRecipients.spec.js +65 -0
- package/test/model/UpdateEmailCampaignSender.spec.js +65 -0
- package/test/model/UpdateExternalFeed.spec.js +101 -0
- package/test/model/UpdateList.spec.js +59 -0
- package/test/model/UpdateSender.spec.js +65 -0
- package/test/model/UpdateSmsCampaign.spec.js +95 -0
- package/test/model/UpdateSmtpTemplate.spec.js +107 -0
- package/test/model/UpdateSmtpTemplateSender.spec.js +65 -0
- package/test/model/UpdateWebhook.spec.js +71 -0
- package/test/model/UpdateWhatsAppCampaign.spec.js +71 -0
- package/test/model/UploadImageModel.spec.js +53 -0
- package/test/model/UploadImageToGallery.spec.js +59 -0
- package/test/model/VariablesItems.spec.js +65 -0
- package/test/model/WhatsappCampStats.spec.js +77 -0
- package/test/model/WhatsappCampTemplate.spec.js +113 -0
|
@@ -0,0 +1,1683 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Brevo API
|
|
3
|
+
* Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
|
4
|
+
*
|
|
5
|
+
* OpenAPI spec version: 3.0.0
|
|
6
|
+
* Contact: contact@brevo.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by the swagger code generator program.
|
|
9
|
+
* https://github.com/swagger-api/swagger-codegen.git
|
|
10
|
+
*
|
|
11
|
+
* Swagger Codegen version: 2.4.32
|
|
12
|
+
*
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*
|
|
15
|
+
*/
|
|
16
|
+
|
|
17
|
+
(function(root, factory) {
|
|
18
|
+
if (typeof define === 'function' && define.amd) {
|
|
19
|
+
// AMD. Register as an anonymous module.
|
|
20
|
+
define(['ApiClient', 'model/AddContactToList', 'model/CreateAttribute', 'model/CreateContact', 'model/CreateDoiContact', 'model/CreateList', 'model/CreateModel', 'model/CreateUpdateContactModel', 'model/CreateUpdateFolder', 'model/CreatedProcessId', 'model/ErrorModel', 'model/GetAttributes', 'model/GetContactCampaignStats', 'model/GetContacts', 'model/GetExtendedContactDetails', 'model/GetExtendedList', 'model/GetFolder', 'model/GetFolderLists', 'model/GetFolders', 'model/GetLists', 'model/GetSegments', 'model/PostContactInfo', 'model/RemoveContactFromList', 'model/RequestContactExport', 'model/RequestContactImport', 'model/UpdateAttribute', 'model/UpdateBatchContacts', 'model/UpdateContact', 'model/UpdateList'], factory);
|
|
21
|
+
} else if (typeof module === 'object' && module.exports) {
|
|
22
|
+
// CommonJS-like environments that support module.exports, like Node.
|
|
23
|
+
module.exports = factory(require('../ApiClient'), require('../model/AddContactToList'), require('../model/CreateAttribute'), require('../model/CreateContact'), require('../model/CreateDoiContact'), require('../model/CreateList'), require('../model/CreateModel'), require('../model/CreateUpdateContactModel'), require('../model/CreateUpdateFolder'), require('../model/CreatedProcessId'), require('../model/ErrorModel'), require('../model/GetAttributes'), require('../model/GetContactCampaignStats'), require('../model/GetContacts'), require('../model/GetExtendedContactDetails'), require('../model/GetExtendedList'), require('../model/GetFolder'), require('../model/GetFolderLists'), require('../model/GetFolders'), require('../model/GetLists'), require('../model/GetSegments'), require('../model/PostContactInfo'), require('../model/RemoveContactFromList'), require('../model/RequestContactExport'), require('../model/RequestContactImport'), require('../model/UpdateAttribute'), require('../model/UpdateBatchContacts'), require('../model/UpdateContact'), require('../model/UpdateList'));
|
|
24
|
+
} else {
|
|
25
|
+
// Browser globals (root is window)
|
|
26
|
+
if (!root.Brevo) {
|
|
27
|
+
root.Brevo = {};
|
|
28
|
+
}
|
|
29
|
+
root.Brevo.ContactsApi = factory(root.Brevo.ApiClient, root.Brevo.AddContactToList, root.Brevo.CreateAttribute, root.Brevo.CreateContact, root.Brevo.CreateDoiContact, root.Brevo.CreateList, root.Brevo.CreateModel, root.Brevo.CreateUpdateContactModel, root.Brevo.CreateUpdateFolder, root.Brevo.CreatedProcessId, root.Brevo.ErrorModel, root.Brevo.GetAttributes, root.Brevo.GetContactCampaignStats, root.Brevo.GetContacts, root.Brevo.GetExtendedContactDetails, root.Brevo.GetExtendedList, root.Brevo.GetFolder, root.Brevo.GetFolderLists, root.Brevo.GetFolders, root.Brevo.GetLists, root.Brevo.GetSegments, root.Brevo.PostContactInfo, root.Brevo.RemoveContactFromList, root.Brevo.RequestContactExport, root.Brevo.RequestContactImport, root.Brevo.UpdateAttribute, root.Brevo.UpdateBatchContacts, root.Brevo.UpdateContact, root.Brevo.UpdateList);
|
|
30
|
+
}
|
|
31
|
+
}(this, function(ApiClient, AddContactToList, CreateAttribute, CreateContact, CreateDoiContact, CreateList, CreateModel, CreateUpdateContactModel, CreateUpdateFolder, CreatedProcessId, ErrorModel, GetAttributes, GetContactCampaignStats, GetContacts, GetExtendedContactDetails, GetExtendedList, GetFolder, GetFolderLists, GetFolders, GetLists, GetSegments, PostContactInfo, RemoveContactFromList, RequestContactExport, RequestContactImport, UpdateAttribute, UpdateBatchContacts, UpdateContact, UpdateList) {
|
|
32
|
+
'use strict';
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* Contacts service.
|
|
36
|
+
* @module api/ContactsApi
|
|
37
|
+
* @version 1.0.0
|
|
38
|
+
*/
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* Constructs a new ContactsApi.
|
|
42
|
+
* @alias module:api/ContactsApi
|
|
43
|
+
* @class
|
|
44
|
+
* @param {module:ApiClient} [apiClient] Optional API client implementation to use,
|
|
45
|
+
* default to {@link module:ApiClient#instance} if unspecified.
|
|
46
|
+
*/
|
|
47
|
+
var exports = function(apiClient) {
|
|
48
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
/**
|
|
53
|
+
* Add existing contacts to a list
|
|
54
|
+
* @param {Number} listId Id of the list
|
|
55
|
+
* @param {module:model/AddContactToList} contactEmails Emails addresses OR IDs of the contacts
|
|
56
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PostContactInfo} and HTTP response
|
|
57
|
+
*/
|
|
58
|
+
this.addContactToListWithHttpInfo = function(listId, contactEmails) {
|
|
59
|
+
var postBody = contactEmails;
|
|
60
|
+
|
|
61
|
+
// verify the required parameter 'listId' is set
|
|
62
|
+
if (listId === undefined || listId === null) {
|
|
63
|
+
throw new Error("Missing the required parameter 'listId' when calling addContactToList");
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
// verify the required parameter 'contactEmails' is set
|
|
67
|
+
if (contactEmails === undefined || contactEmails === null) {
|
|
68
|
+
throw new Error("Missing the required parameter 'contactEmails' when calling addContactToList");
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
var pathParams = {
|
|
73
|
+
'listId': listId
|
|
74
|
+
};
|
|
75
|
+
var queryParams = {
|
|
76
|
+
};
|
|
77
|
+
var collectionQueryParams = {
|
|
78
|
+
};
|
|
79
|
+
var headerParams = {
|
|
80
|
+
};
|
|
81
|
+
var formParams = {
|
|
82
|
+
};
|
|
83
|
+
|
|
84
|
+
var authNames = ['api-key', 'partner-key'];
|
|
85
|
+
var contentTypes = ['application/json'];
|
|
86
|
+
var accepts = ['application/json'];
|
|
87
|
+
var returnType = PostContactInfo;
|
|
88
|
+
|
|
89
|
+
return this.apiClient.callApi(
|
|
90
|
+
'/contacts/lists/{listId}/contacts/add', 'POST',
|
|
91
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
92
|
+
authNames, contentTypes, accepts, returnType
|
|
93
|
+
);
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
/**
|
|
97
|
+
* Add existing contacts to a list
|
|
98
|
+
* @param {Number} listId Id of the list
|
|
99
|
+
* @param {module:model/AddContactToList} contactEmails Emails addresses OR IDs of the contacts
|
|
100
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PostContactInfo}
|
|
101
|
+
*/
|
|
102
|
+
this.addContactToList = function(listId, contactEmails) {
|
|
103
|
+
return this.addContactToListWithHttpInfo(listId, contactEmails)
|
|
104
|
+
.then(function(response_and_data) {
|
|
105
|
+
return response_and_data.data;
|
|
106
|
+
});
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
/**
|
|
111
|
+
* Create contact attribute
|
|
112
|
+
* @param {module:model/String} attributeCategory Category of the attribute
|
|
113
|
+
* @param {String} attributeName Name of the attribute
|
|
114
|
+
* @param {module:model/CreateAttribute} createAttribute Values to create an attribute
|
|
115
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
116
|
+
*/
|
|
117
|
+
this.createAttributeWithHttpInfo = function(attributeCategory, attributeName, createAttribute) {
|
|
118
|
+
var postBody = createAttribute;
|
|
119
|
+
|
|
120
|
+
// verify the required parameter 'attributeCategory' is set
|
|
121
|
+
if (attributeCategory === undefined || attributeCategory === null) {
|
|
122
|
+
throw new Error("Missing the required parameter 'attributeCategory' when calling createAttribute");
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
// verify the required parameter 'attributeName' is set
|
|
126
|
+
if (attributeName === undefined || attributeName === null) {
|
|
127
|
+
throw new Error("Missing the required parameter 'attributeName' when calling createAttribute");
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
// verify the required parameter 'createAttribute' is set
|
|
131
|
+
if (createAttribute === undefined || createAttribute === null) {
|
|
132
|
+
throw new Error("Missing the required parameter 'createAttribute' when calling createAttribute");
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
var pathParams = {
|
|
137
|
+
'attributeCategory': attributeCategory,
|
|
138
|
+
'attributeName': attributeName
|
|
139
|
+
};
|
|
140
|
+
var queryParams = {
|
|
141
|
+
};
|
|
142
|
+
var collectionQueryParams = {
|
|
143
|
+
};
|
|
144
|
+
var headerParams = {
|
|
145
|
+
};
|
|
146
|
+
var formParams = {
|
|
147
|
+
};
|
|
148
|
+
|
|
149
|
+
var authNames = ['api-key', 'partner-key'];
|
|
150
|
+
var contentTypes = ['application/json'];
|
|
151
|
+
var accepts = ['application/json'];
|
|
152
|
+
var returnType = null;
|
|
153
|
+
|
|
154
|
+
return this.apiClient.callApi(
|
|
155
|
+
'/contacts/attributes/{attributeCategory}/{attributeName}', 'POST',
|
|
156
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
157
|
+
authNames, contentTypes, accepts, returnType
|
|
158
|
+
);
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
/**
|
|
162
|
+
* Create contact attribute
|
|
163
|
+
* @param {module:model/String} attributeCategory Category of the attribute
|
|
164
|
+
* @param {String} attributeName Name of the attribute
|
|
165
|
+
* @param {module:model/CreateAttribute} createAttribute Values to create an attribute
|
|
166
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
167
|
+
*/
|
|
168
|
+
this.createAttribute = function(attributeCategory, attributeName, createAttribute) {
|
|
169
|
+
return this.createAttributeWithHttpInfo(attributeCategory, attributeName, createAttribute)
|
|
170
|
+
.then(function(response_and_data) {
|
|
171
|
+
return response_and_data.data;
|
|
172
|
+
});
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
/**
|
|
177
|
+
* Create a contact
|
|
178
|
+
* @param {module:model/CreateContact} createContact Values to create a contact
|
|
179
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateUpdateContactModel} and HTTP response
|
|
180
|
+
*/
|
|
181
|
+
this.createContactWithHttpInfo = function(createContact) {
|
|
182
|
+
var postBody = createContact;
|
|
183
|
+
|
|
184
|
+
// verify the required parameter 'createContact' is set
|
|
185
|
+
if (createContact === undefined || createContact === null) {
|
|
186
|
+
throw new Error("Missing the required parameter 'createContact' when calling createContact");
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
var pathParams = {
|
|
191
|
+
};
|
|
192
|
+
var queryParams = {
|
|
193
|
+
};
|
|
194
|
+
var collectionQueryParams = {
|
|
195
|
+
};
|
|
196
|
+
var headerParams = {
|
|
197
|
+
};
|
|
198
|
+
var formParams = {
|
|
199
|
+
};
|
|
200
|
+
|
|
201
|
+
var authNames = ['api-key', 'partner-key'];
|
|
202
|
+
var contentTypes = ['application/json'];
|
|
203
|
+
var accepts = ['application/json'];
|
|
204
|
+
var returnType = CreateUpdateContactModel;
|
|
205
|
+
|
|
206
|
+
return this.apiClient.callApi(
|
|
207
|
+
'/contacts', 'POST',
|
|
208
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
209
|
+
authNames, contentTypes, accepts, returnType
|
|
210
|
+
);
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
/**
|
|
214
|
+
* Create a contact
|
|
215
|
+
* @param {module:model/CreateContact} createContact Values to create a contact
|
|
216
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateUpdateContactModel}
|
|
217
|
+
*/
|
|
218
|
+
this.createContact = function(createContact) {
|
|
219
|
+
return this.createContactWithHttpInfo(createContact)
|
|
220
|
+
.then(function(response_and_data) {
|
|
221
|
+
return response_and_data.data;
|
|
222
|
+
});
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
/**
|
|
227
|
+
* Create Contact via DOI (Double-Opt-In) Flow
|
|
228
|
+
* @param {module:model/CreateDoiContact} createDoiContact Values to create the Double opt-in (DOI) contact
|
|
229
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
230
|
+
*/
|
|
231
|
+
this.createDoiContactWithHttpInfo = function(createDoiContact) {
|
|
232
|
+
var postBody = createDoiContact;
|
|
233
|
+
|
|
234
|
+
// verify the required parameter 'createDoiContact' is set
|
|
235
|
+
if (createDoiContact === undefined || createDoiContact === null) {
|
|
236
|
+
throw new Error("Missing the required parameter 'createDoiContact' when calling createDoiContact");
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
var pathParams = {
|
|
241
|
+
};
|
|
242
|
+
var queryParams = {
|
|
243
|
+
};
|
|
244
|
+
var collectionQueryParams = {
|
|
245
|
+
};
|
|
246
|
+
var headerParams = {
|
|
247
|
+
};
|
|
248
|
+
var formParams = {
|
|
249
|
+
};
|
|
250
|
+
|
|
251
|
+
var authNames = ['api-key', 'partner-key'];
|
|
252
|
+
var contentTypes = ['application/json'];
|
|
253
|
+
var accepts = ['application/json'];
|
|
254
|
+
var returnType = null;
|
|
255
|
+
|
|
256
|
+
return this.apiClient.callApi(
|
|
257
|
+
'/contacts/doubleOptinConfirmation', 'POST',
|
|
258
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
259
|
+
authNames, contentTypes, accepts, returnType
|
|
260
|
+
);
|
|
261
|
+
}
|
|
262
|
+
|
|
263
|
+
/**
|
|
264
|
+
* Create Contact via DOI (Double-Opt-In) Flow
|
|
265
|
+
* @param {module:model/CreateDoiContact} createDoiContact Values to create the Double opt-in (DOI) contact
|
|
266
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
267
|
+
*/
|
|
268
|
+
this.createDoiContact = function(createDoiContact) {
|
|
269
|
+
return this.createDoiContactWithHttpInfo(createDoiContact)
|
|
270
|
+
.then(function(response_and_data) {
|
|
271
|
+
return response_and_data.data;
|
|
272
|
+
});
|
|
273
|
+
}
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
/**
|
|
277
|
+
* Create a folder
|
|
278
|
+
* @param {module:model/CreateUpdateFolder} createFolder Name of the folder
|
|
279
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateModel} and HTTP response
|
|
280
|
+
*/
|
|
281
|
+
this.createFolderWithHttpInfo = function(createFolder) {
|
|
282
|
+
var postBody = createFolder;
|
|
283
|
+
|
|
284
|
+
// verify the required parameter 'createFolder' is set
|
|
285
|
+
if (createFolder === undefined || createFolder === null) {
|
|
286
|
+
throw new Error("Missing the required parameter 'createFolder' when calling createFolder");
|
|
287
|
+
}
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
var pathParams = {
|
|
291
|
+
};
|
|
292
|
+
var queryParams = {
|
|
293
|
+
};
|
|
294
|
+
var collectionQueryParams = {
|
|
295
|
+
};
|
|
296
|
+
var headerParams = {
|
|
297
|
+
};
|
|
298
|
+
var formParams = {
|
|
299
|
+
};
|
|
300
|
+
|
|
301
|
+
var authNames = ['api-key', 'partner-key'];
|
|
302
|
+
var contentTypes = ['application/json'];
|
|
303
|
+
var accepts = ['application/json'];
|
|
304
|
+
var returnType = CreateModel;
|
|
305
|
+
|
|
306
|
+
return this.apiClient.callApi(
|
|
307
|
+
'/contacts/folders', 'POST',
|
|
308
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
309
|
+
authNames, contentTypes, accepts, returnType
|
|
310
|
+
);
|
|
311
|
+
}
|
|
312
|
+
|
|
313
|
+
/**
|
|
314
|
+
* Create a folder
|
|
315
|
+
* @param {module:model/CreateUpdateFolder} createFolder Name of the folder
|
|
316
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateModel}
|
|
317
|
+
*/
|
|
318
|
+
this.createFolder = function(createFolder) {
|
|
319
|
+
return this.createFolderWithHttpInfo(createFolder)
|
|
320
|
+
.then(function(response_and_data) {
|
|
321
|
+
return response_and_data.data;
|
|
322
|
+
});
|
|
323
|
+
}
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
/**
|
|
327
|
+
* Create a list
|
|
328
|
+
* @param {module:model/CreateList} createList Values to create a list
|
|
329
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateModel} and HTTP response
|
|
330
|
+
*/
|
|
331
|
+
this.createListWithHttpInfo = function(createList) {
|
|
332
|
+
var postBody = createList;
|
|
333
|
+
|
|
334
|
+
// verify the required parameter 'createList' is set
|
|
335
|
+
if (createList === undefined || createList === null) {
|
|
336
|
+
throw new Error("Missing the required parameter 'createList' when calling createList");
|
|
337
|
+
}
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
var pathParams = {
|
|
341
|
+
};
|
|
342
|
+
var queryParams = {
|
|
343
|
+
};
|
|
344
|
+
var collectionQueryParams = {
|
|
345
|
+
};
|
|
346
|
+
var headerParams = {
|
|
347
|
+
};
|
|
348
|
+
var formParams = {
|
|
349
|
+
};
|
|
350
|
+
|
|
351
|
+
var authNames = ['api-key', 'partner-key'];
|
|
352
|
+
var contentTypes = ['application/json'];
|
|
353
|
+
var accepts = ['application/json'];
|
|
354
|
+
var returnType = CreateModel;
|
|
355
|
+
|
|
356
|
+
return this.apiClient.callApi(
|
|
357
|
+
'/contacts/lists', 'POST',
|
|
358
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
359
|
+
authNames, contentTypes, accepts, returnType
|
|
360
|
+
);
|
|
361
|
+
}
|
|
362
|
+
|
|
363
|
+
/**
|
|
364
|
+
* Create a list
|
|
365
|
+
* @param {module:model/CreateList} createList Values to create a list
|
|
366
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateModel}
|
|
367
|
+
*/
|
|
368
|
+
this.createList = function(createList) {
|
|
369
|
+
return this.createListWithHttpInfo(createList)
|
|
370
|
+
.then(function(response_and_data) {
|
|
371
|
+
return response_and_data.data;
|
|
372
|
+
});
|
|
373
|
+
}
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
/**
|
|
377
|
+
* Delete an attribute
|
|
378
|
+
* @param {module:model/String} attributeCategory Category of the attribute
|
|
379
|
+
* @param {String} attributeName Name of the existing attribute
|
|
380
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
381
|
+
*/
|
|
382
|
+
this.deleteAttributeWithHttpInfo = function(attributeCategory, attributeName) {
|
|
383
|
+
var postBody = null;
|
|
384
|
+
|
|
385
|
+
// verify the required parameter 'attributeCategory' is set
|
|
386
|
+
if (attributeCategory === undefined || attributeCategory === null) {
|
|
387
|
+
throw new Error("Missing the required parameter 'attributeCategory' when calling deleteAttribute");
|
|
388
|
+
}
|
|
389
|
+
|
|
390
|
+
// verify the required parameter 'attributeName' is set
|
|
391
|
+
if (attributeName === undefined || attributeName === null) {
|
|
392
|
+
throw new Error("Missing the required parameter 'attributeName' when calling deleteAttribute");
|
|
393
|
+
}
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
var pathParams = {
|
|
397
|
+
'attributeCategory': attributeCategory,
|
|
398
|
+
'attributeName': attributeName
|
|
399
|
+
};
|
|
400
|
+
var queryParams = {
|
|
401
|
+
};
|
|
402
|
+
var collectionQueryParams = {
|
|
403
|
+
};
|
|
404
|
+
var headerParams = {
|
|
405
|
+
};
|
|
406
|
+
var formParams = {
|
|
407
|
+
};
|
|
408
|
+
|
|
409
|
+
var authNames = ['api-key', 'partner-key'];
|
|
410
|
+
var contentTypes = ['application/json'];
|
|
411
|
+
var accepts = ['application/json'];
|
|
412
|
+
var returnType = null;
|
|
413
|
+
|
|
414
|
+
return this.apiClient.callApi(
|
|
415
|
+
'/contacts/attributes/{attributeCategory}/{attributeName}', 'DELETE',
|
|
416
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
417
|
+
authNames, contentTypes, accepts, returnType
|
|
418
|
+
);
|
|
419
|
+
}
|
|
420
|
+
|
|
421
|
+
/**
|
|
422
|
+
* Delete an attribute
|
|
423
|
+
* @param {module:model/String} attributeCategory Category of the attribute
|
|
424
|
+
* @param {String} attributeName Name of the existing attribute
|
|
425
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
426
|
+
*/
|
|
427
|
+
this.deleteAttribute = function(attributeCategory, attributeName) {
|
|
428
|
+
return this.deleteAttributeWithHttpInfo(attributeCategory, attributeName)
|
|
429
|
+
.then(function(response_and_data) {
|
|
430
|
+
return response_and_data.data;
|
|
431
|
+
});
|
|
432
|
+
}
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
/**
|
|
436
|
+
* Delete a contact
|
|
437
|
+
* @param {String} identifier Email (urlencoded) OR ID of the contact
|
|
438
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
439
|
+
*/
|
|
440
|
+
this.deleteContactWithHttpInfo = function(identifier) {
|
|
441
|
+
var postBody = null;
|
|
442
|
+
|
|
443
|
+
// verify the required parameter 'identifier' is set
|
|
444
|
+
if (identifier === undefined || identifier === null) {
|
|
445
|
+
throw new Error("Missing the required parameter 'identifier' when calling deleteContact");
|
|
446
|
+
}
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
var pathParams = {
|
|
450
|
+
'identifier': identifier
|
|
451
|
+
};
|
|
452
|
+
var queryParams = {
|
|
453
|
+
};
|
|
454
|
+
var collectionQueryParams = {
|
|
455
|
+
};
|
|
456
|
+
var headerParams = {
|
|
457
|
+
};
|
|
458
|
+
var formParams = {
|
|
459
|
+
};
|
|
460
|
+
|
|
461
|
+
var authNames = ['api-key', 'partner-key'];
|
|
462
|
+
var contentTypes = ['application/json'];
|
|
463
|
+
var accepts = ['application/json'];
|
|
464
|
+
var returnType = null;
|
|
465
|
+
|
|
466
|
+
return this.apiClient.callApi(
|
|
467
|
+
'/contacts/{identifier}', 'DELETE',
|
|
468
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
469
|
+
authNames, contentTypes, accepts, returnType
|
|
470
|
+
);
|
|
471
|
+
}
|
|
472
|
+
|
|
473
|
+
/**
|
|
474
|
+
* Delete a contact
|
|
475
|
+
* @param {String} identifier Email (urlencoded) OR ID of the contact
|
|
476
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
477
|
+
*/
|
|
478
|
+
this.deleteContact = function(identifier) {
|
|
479
|
+
return this.deleteContactWithHttpInfo(identifier)
|
|
480
|
+
.then(function(response_and_data) {
|
|
481
|
+
return response_and_data.data;
|
|
482
|
+
});
|
|
483
|
+
}
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
/**
|
|
487
|
+
* Delete a folder (and all its lists)
|
|
488
|
+
* @param {Number} folderId Id of the folder
|
|
489
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
490
|
+
*/
|
|
491
|
+
this.deleteFolderWithHttpInfo = function(folderId) {
|
|
492
|
+
var postBody = null;
|
|
493
|
+
|
|
494
|
+
// verify the required parameter 'folderId' is set
|
|
495
|
+
if (folderId === undefined || folderId === null) {
|
|
496
|
+
throw new Error("Missing the required parameter 'folderId' when calling deleteFolder");
|
|
497
|
+
}
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
var pathParams = {
|
|
501
|
+
'folderId': folderId
|
|
502
|
+
};
|
|
503
|
+
var queryParams = {
|
|
504
|
+
};
|
|
505
|
+
var collectionQueryParams = {
|
|
506
|
+
};
|
|
507
|
+
var headerParams = {
|
|
508
|
+
};
|
|
509
|
+
var formParams = {
|
|
510
|
+
};
|
|
511
|
+
|
|
512
|
+
var authNames = ['api-key', 'partner-key'];
|
|
513
|
+
var contentTypes = ['application/json'];
|
|
514
|
+
var accepts = ['application/json'];
|
|
515
|
+
var returnType = null;
|
|
516
|
+
|
|
517
|
+
return this.apiClient.callApi(
|
|
518
|
+
'/contacts/folders/{folderId}', 'DELETE',
|
|
519
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
520
|
+
authNames, contentTypes, accepts, returnType
|
|
521
|
+
);
|
|
522
|
+
}
|
|
523
|
+
|
|
524
|
+
/**
|
|
525
|
+
* Delete a folder (and all its lists)
|
|
526
|
+
* @param {Number} folderId Id of the folder
|
|
527
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
528
|
+
*/
|
|
529
|
+
this.deleteFolder = function(folderId) {
|
|
530
|
+
return this.deleteFolderWithHttpInfo(folderId)
|
|
531
|
+
.then(function(response_and_data) {
|
|
532
|
+
return response_and_data.data;
|
|
533
|
+
});
|
|
534
|
+
}
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
/**
|
|
538
|
+
* Delete a list
|
|
539
|
+
* @param {Number} listId Id of the list
|
|
540
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
541
|
+
*/
|
|
542
|
+
this.deleteListWithHttpInfo = function(listId) {
|
|
543
|
+
var postBody = null;
|
|
544
|
+
|
|
545
|
+
// verify the required parameter 'listId' is set
|
|
546
|
+
if (listId === undefined || listId === null) {
|
|
547
|
+
throw new Error("Missing the required parameter 'listId' when calling deleteList");
|
|
548
|
+
}
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
var pathParams = {
|
|
552
|
+
'listId': listId
|
|
553
|
+
};
|
|
554
|
+
var queryParams = {
|
|
555
|
+
};
|
|
556
|
+
var collectionQueryParams = {
|
|
557
|
+
};
|
|
558
|
+
var headerParams = {
|
|
559
|
+
};
|
|
560
|
+
var formParams = {
|
|
561
|
+
};
|
|
562
|
+
|
|
563
|
+
var authNames = ['api-key', 'partner-key'];
|
|
564
|
+
var contentTypes = ['application/json'];
|
|
565
|
+
var accepts = ['application/json'];
|
|
566
|
+
var returnType = null;
|
|
567
|
+
|
|
568
|
+
return this.apiClient.callApi(
|
|
569
|
+
'/contacts/lists/{listId}', 'DELETE',
|
|
570
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
571
|
+
authNames, contentTypes, accepts, returnType
|
|
572
|
+
);
|
|
573
|
+
}
|
|
574
|
+
|
|
575
|
+
/**
|
|
576
|
+
* Delete a list
|
|
577
|
+
* @param {Number} listId Id of the list
|
|
578
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
579
|
+
*/
|
|
580
|
+
this.deleteList = function(listId) {
|
|
581
|
+
return this.deleteListWithHttpInfo(listId)
|
|
582
|
+
.then(function(response_and_data) {
|
|
583
|
+
return response_and_data.data;
|
|
584
|
+
});
|
|
585
|
+
}
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
/**
|
|
589
|
+
* List all attributes
|
|
590
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetAttributes} and HTTP response
|
|
591
|
+
*/
|
|
592
|
+
this.getAttributesWithHttpInfo = function() {
|
|
593
|
+
var postBody = null;
|
|
594
|
+
|
|
595
|
+
|
|
596
|
+
var pathParams = {
|
|
597
|
+
};
|
|
598
|
+
var queryParams = {
|
|
599
|
+
};
|
|
600
|
+
var collectionQueryParams = {
|
|
601
|
+
};
|
|
602
|
+
var headerParams = {
|
|
603
|
+
};
|
|
604
|
+
var formParams = {
|
|
605
|
+
};
|
|
606
|
+
|
|
607
|
+
var authNames = ['api-key', 'partner-key'];
|
|
608
|
+
var contentTypes = ['application/json'];
|
|
609
|
+
var accepts = ['application/json'];
|
|
610
|
+
var returnType = GetAttributes;
|
|
611
|
+
|
|
612
|
+
return this.apiClient.callApi(
|
|
613
|
+
'/contacts/attributes', 'GET',
|
|
614
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
615
|
+
authNames, contentTypes, accepts, returnType
|
|
616
|
+
);
|
|
617
|
+
}
|
|
618
|
+
|
|
619
|
+
/**
|
|
620
|
+
* List all attributes
|
|
621
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetAttributes}
|
|
622
|
+
*/
|
|
623
|
+
this.getAttributes = function() {
|
|
624
|
+
return this.getAttributesWithHttpInfo()
|
|
625
|
+
.then(function(response_and_data) {
|
|
626
|
+
return response_and_data.data;
|
|
627
|
+
});
|
|
628
|
+
}
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
/**
|
|
632
|
+
* Get a contact's details
|
|
633
|
+
* Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats (https://developers.brevo.com/reference/contacts-7#getcontactstats) endpoint with the appropriate date ranges.
|
|
634
|
+
* @param {String} identifier Email (urlencoded) OR ID of the contact OR its SMS attribute value
|
|
635
|
+
* @param {Object} opts Optional parameters
|
|
636
|
+
* @param {String} opts.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
|
|
637
|
+
* @param {String} opts.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.
|
|
638
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetExtendedContactDetails} and HTTP response
|
|
639
|
+
*/
|
|
640
|
+
this.getContactInfoWithHttpInfo = function(identifier, opts) {
|
|
641
|
+
opts = opts || {};
|
|
642
|
+
var postBody = null;
|
|
643
|
+
|
|
644
|
+
// verify the required parameter 'identifier' is set
|
|
645
|
+
if (identifier === undefined || identifier === null) {
|
|
646
|
+
throw new Error("Missing the required parameter 'identifier' when calling getContactInfo");
|
|
647
|
+
}
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
var pathParams = {
|
|
651
|
+
'identifier': identifier
|
|
652
|
+
};
|
|
653
|
+
var queryParams = {
|
|
654
|
+
'startDate': opts['startDate'],
|
|
655
|
+
'endDate': opts['endDate'],
|
|
656
|
+
};
|
|
657
|
+
var collectionQueryParams = {
|
|
658
|
+
};
|
|
659
|
+
var headerParams = {
|
|
660
|
+
};
|
|
661
|
+
var formParams = {
|
|
662
|
+
};
|
|
663
|
+
|
|
664
|
+
var authNames = ['api-key', 'partner-key'];
|
|
665
|
+
var contentTypes = ['application/json'];
|
|
666
|
+
var accepts = ['application/json'];
|
|
667
|
+
var returnType = GetExtendedContactDetails;
|
|
668
|
+
|
|
669
|
+
return this.apiClient.callApi(
|
|
670
|
+
'/contacts/{identifier}', 'GET',
|
|
671
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
672
|
+
authNames, contentTypes, accepts, returnType
|
|
673
|
+
);
|
|
674
|
+
}
|
|
675
|
+
|
|
676
|
+
/**
|
|
677
|
+
* Get a contact's details
|
|
678
|
+
* Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats (https://developers.brevo.com/reference/contacts-7#getcontactstats) endpoint with the appropriate date ranges.
|
|
679
|
+
* @param {String} identifier Email (urlencoded) OR ID of the contact OR its SMS attribute value
|
|
680
|
+
* @param {Object} opts Optional parameters
|
|
681
|
+
* @param {String} opts.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
|
|
682
|
+
* @param {String} opts.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.
|
|
683
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetExtendedContactDetails}
|
|
684
|
+
*/
|
|
685
|
+
this.getContactInfo = function(identifier, opts) {
|
|
686
|
+
return this.getContactInfoWithHttpInfo(identifier, opts)
|
|
687
|
+
.then(function(response_and_data) {
|
|
688
|
+
return response_and_data.data;
|
|
689
|
+
});
|
|
690
|
+
}
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
/**
|
|
694
|
+
* Get email campaigns' statistics for a contact
|
|
695
|
+
* @param {String} identifier Email (urlencoded) OR ID of the contact
|
|
696
|
+
* @param {Object} opts Optional parameters
|
|
697
|
+
* @param {String} opts.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
|
|
698
|
+
* @param {String} opts.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. Maximum difference between startDate and endDate should not be greater than 90 days
|
|
699
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetContactCampaignStats} and HTTP response
|
|
700
|
+
*/
|
|
701
|
+
this.getContactStatsWithHttpInfo = function(identifier, opts) {
|
|
702
|
+
opts = opts || {};
|
|
703
|
+
var postBody = null;
|
|
704
|
+
|
|
705
|
+
// verify the required parameter 'identifier' is set
|
|
706
|
+
if (identifier === undefined || identifier === null) {
|
|
707
|
+
throw new Error("Missing the required parameter 'identifier' when calling getContactStats");
|
|
708
|
+
}
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
var pathParams = {
|
|
712
|
+
'identifier': identifier
|
|
713
|
+
};
|
|
714
|
+
var queryParams = {
|
|
715
|
+
'startDate': opts['startDate'],
|
|
716
|
+
'endDate': opts['endDate'],
|
|
717
|
+
};
|
|
718
|
+
var collectionQueryParams = {
|
|
719
|
+
};
|
|
720
|
+
var headerParams = {
|
|
721
|
+
};
|
|
722
|
+
var formParams = {
|
|
723
|
+
};
|
|
724
|
+
|
|
725
|
+
var authNames = ['api-key', 'partner-key'];
|
|
726
|
+
var contentTypes = ['application/json'];
|
|
727
|
+
var accepts = ['application/json'];
|
|
728
|
+
var returnType = GetContactCampaignStats;
|
|
729
|
+
|
|
730
|
+
return this.apiClient.callApi(
|
|
731
|
+
'/contacts/{identifier}/campaignStats', 'GET',
|
|
732
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
733
|
+
authNames, contentTypes, accepts, returnType
|
|
734
|
+
);
|
|
735
|
+
}
|
|
736
|
+
|
|
737
|
+
/**
|
|
738
|
+
* Get email campaigns' statistics for a contact
|
|
739
|
+
* @param {String} identifier Email (urlencoded) OR ID of the contact
|
|
740
|
+
* @param {Object} opts Optional parameters
|
|
741
|
+
* @param {String} opts.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
|
|
742
|
+
* @param {String} opts.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. Maximum difference between startDate and endDate should not be greater than 90 days
|
|
743
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetContactCampaignStats}
|
|
744
|
+
*/
|
|
745
|
+
this.getContactStats = function(identifier, opts) {
|
|
746
|
+
return this.getContactStatsWithHttpInfo(identifier, opts)
|
|
747
|
+
.then(function(response_and_data) {
|
|
748
|
+
return response_and_data.data;
|
|
749
|
+
});
|
|
750
|
+
}
|
|
751
|
+
|
|
752
|
+
|
|
753
|
+
/**
|
|
754
|
+
* Get all the contacts
|
|
755
|
+
* @param {Object} opts Optional parameters
|
|
756
|
+
* @param {Number} opts.limit Number of documents per page (default to 50)
|
|
757
|
+
* @param {Number} opts.offset Index of the first document of the page (default to 0)
|
|
758
|
+
* @param {String} opts.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.
|
|
759
|
+
* @param {String} opts.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.
|
|
760
|
+
* @param {module:model/String} opts.sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
|
761
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetContacts} and HTTP response
|
|
762
|
+
*/
|
|
763
|
+
this.getContactsWithHttpInfo = function(opts) {
|
|
764
|
+
opts = opts || {};
|
|
765
|
+
var postBody = null;
|
|
766
|
+
|
|
767
|
+
|
|
768
|
+
var pathParams = {
|
|
769
|
+
};
|
|
770
|
+
var queryParams = {
|
|
771
|
+
'limit': opts['limit'],
|
|
772
|
+
'offset': opts['offset'],
|
|
773
|
+
'modifiedSince': opts['modifiedSince'],
|
|
774
|
+
'createdSince': opts['createdSince'],
|
|
775
|
+
'sort': opts['sort'],
|
|
776
|
+
};
|
|
777
|
+
var collectionQueryParams = {
|
|
778
|
+
};
|
|
779
|
+
var headerParams = {
|
|
780
|
+
};
|
|
781
|
+
var formParams = {
|
|
782
|
+
};
|
|
783
|
+
|
|
784
|
+
var authNames = ['api-key', 'partner-key'];
|
|
785
|
+
var contentTypes = ['application/json'];
|
|
786
|
+
var accepts = ['application/json'];
|
|
787
|
+
var returnType = GetContacts;
|
|
788
|
+
|
|
789
|
+
return this.apiClient.callApi(
|
|
790
|
+
'/contacts', 'GET',
|
|
791
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
792
|
+
authNames, contentTypes, accepts, returnType
|
|
793
|
+
);
|
|
794
|
+
}
|
|
795
|
+
|
|
796
|
+
/**
|
|
797
|
+
* Get all the contacts
|
|
798
|
+
* @param {Object} opts Optional parameters
|
|
799
|
+
* @param {Number} opts.limit Number of documents per page (default to 50)
|
|
800
|
+
* @param {Number} opts.offset Index of the first document of the page (default to 0)
|
|
801
|
+
* @param {String} opts.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.
|
|
802
|
+
* @param {String} opts.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.
|
|
803
|
+
* @param {module:model/String} opts.sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
|
804
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetContacts}
|
|
805
|
+
*/
|
|
806
|
+
this.getContacts = function(opts) {
|
|
807
|
+
return this.getContactsWithHttpInfo(opts)
|
|
808
|
+
.then(function(response_and_data) {
|
|
809
|
+
return response_and_data.data;
|
|
810
|
+
});
|
|
811
|
+
}
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
/**
|
|
815
|
+
* Get contacts in a list
|
|
816
|
+
* @param {Number} listId Id of the list
|
|
817
|
+
* @param {Object} opts Optional parameters
|
|
818
|
+
* @param {String} opts.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.
|
|
819
|
+
* @param {Number} opts.limit Number of documents per page (default to 50)
|
|
820
|
+
* @param {Number} opts.offset Index of the first document of the page (default to 0)
|
|
821
|
+
* @param {module:model/String} opts.sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
|
822
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetContacts} and HTTP response
|
|
823
|
+
*/
|
|
824
|
+
this.getContactsFromListWithHttpInfo = function(listId, opts) {
|
|
825
|
+
opts = opts || {};
|
|
826
|
+
var postBody = null;
|
|
827
|
+
|
|
828
|
+
// verify the required parameter 'listId' is set
|
|
829
|
+
if (listId === undefined || listId === null) {
|
|
830
|
+
throw new Error("Missing the required parameter 'listId' when calling getContactsFromList");
|
|
831
|
+
}
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
var pathParams = {
|
|
835
|
+
'listId': listId
|
|
836
|
+
};
|
|
837
|
+
var queryParams = {
|
|
838
|
+
'modifiedSince': opts['modifiedSince'],
|
|
839
|
+
'limit': opts['limit'],
|
|
840
|
+
'offset': opts['offset'],
|
|
841
|
+
'sort': opts['sort'],
|
|
842
|
+
};
|
|
843
|
+
var collectionQueryParams = {
|
|
844
|
+
};
|
|
845
|
+
var headerParams = {
|
|
846
|
+
};
|
|
847
|
+
var formParams = {
|
|
848
|
+
};
|
|
849
|
+
|
|
850
|
+
var authNames = ['api-key', 'partner-key'];
|
|
851
|
+
var contentTypes = ['application/json'];
|
|
852
|
+
var accepts = ['application/json'];
|
|
853
|
+
var returnType = GetContacts;
|
|
854
|
+
|
|
855
|
+
return this.apiClient.callApi(
|
|
856
|
+
'/contacts/lists/{listId}/contacts', 'GET',
|
|
857
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
858
|
+
authNames, contentTypes, accepts, returnType
|
|
859
|
+
);
|
|
860
|
+
}
|
|
861
|
+
|
|
862
|
+
/**
|
|
863
|
+
* Get contacts in a list
|
|
864
|
+
* @param {Number} listId Id of the list
|
|
865
|
+
* @param {Object} opts Optional parameters
|
|
866
|
+
* @param {String} opts.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.
|
|
867
|
+
* @param {Number} opts.limit Number of documents per page (default to 50)
|
|
868
|
+
* @param {Number} opts.offset Index of the first document of the page (default to 0)
|
|
869
|
+
* @param {module:model/String} opts.sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
|
870
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetContacts}
|
|
871
|
+
*/
|
|
872
|
+
this.getContactsFromList = function(listId, opts) {
|
|
873
|
+
return this.getContactsFromListWithHttpInfo(listId, opts)
|
|
874
|
+
.then(function(response_and_data) {
|
|
875
|
+
return response_and_data.data;
|
|
876
|
+
});
|
|
877
|
+
}
|
|
878
|
+
|
|
879
|
+
|
|
880
|
+
/**
|
|
881
|
+
* Returns a folder's details
|
|
882
|
+
* @param {Number} folderId id of the folder
|
|
883
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetFolder} and HTTP response
|
|
884
|
+
*/
|
|
885
|
+
this.getFolderWithHttpInfo = function(folderId) {
|
|
886
|
+
var postBody = null;
|
|
887
|
+
|
|
888
|
+
// verify the required parameter 'folderId' is set
|
|
889
|
+
if (folderId === undefined || folderId === null) {
|
|
890
|
+
throw new Error("Missing the required parameter 'folderId' when calling getFolder");
|
|
891
|
+
}
|
|
892
|
+
|
|
893
|
+
|
|
894
|
+
var pathParams = {
|
|
895
|
+
'folderId': folderId
|
|
896
|
+
};
|
|
897
|
+
var queryParams = {
|
|
898
|
+
};
|
|
899
|
+
var collectionQueryParams = {
|
|
900
|
+
};
|
|
901
|
+
var headerParams = {
|
|
902
|
+
};
|
|
903
|
+
var formParams = {
|
|
904
|
+
};
|
|
905
|
+
|
|
906
|
+
var authNames = ['api-key', 'partner-key'];
|
|
907
|
+
var contentTypes = ['application/json'];
|
|
908
|
+
var accepts = ['application/json'];
|
|
909
|
+
var returnType = GetFolder;
|
|
910
|
+
|
|
911
|
+
return this.apiClient.callApi(
|
|
912
|
+
'/contacts/folders/{folderId}', 'GET',
|
|
913
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
914
|
+
authNames, contentTypes, accepts, returnType
|
|
915
|
+
);
|
|
916
|
+
}
|
|
917
|
+
|
|
918
|
+
/**
|
|
919
|
+
* Returns a folder's details
|
|
920
|
+
* @param {Number} folderId id of the folder
|
|
921
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetFolder}
|
|
922
|
+
*/
|
|
923
|
+
this.getFolder = function(folderId) {
|
|
924
|
+
return this.getFolderWithHttpInfo(folderId)
|
|
925
|
+
.then(function(response_and_data) {
|
|
926
|
+
return response_and_data.data;
|
|
927
|
+
});
|
|
928
|
+
}
|
|
929
|
+
|
|
930
|
+
|
|
931
|
+
/**
|
|
932
|
+
* Get lists in a folder
|
|
933
|
+
* @param {Number} folderId Id of the folder
|
|
934
|
+
* @param {Object} opts Optional parameters
|
|
935
|
+
* @param {Number} opts.limit Number of documents per page (default to 10)
|
|
936
|
+
* @param {Number} opts.offset Index of the first document of the page (default to 0)
|
|
937
|
+
* @param {module:model/String} opts.sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
|
938
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetFolderLists} and HTTP response
|
|
939
|
+
*/
|
|
940
|
+
this.getFolderListsWithHttpInfo = function(folderId, opts) {
|
|
941
|
+
opts = opts || {};
|
|
942
|
+
var postBody = null;
|
|
943
|
+
|
|
944
|
+
// verify the required parameter 'folderId' is set
|
|
945
|
+
if (folderId === undefined || folderId === null) {
|
|
946
|
+
throw new Error("Missing the required parameter 'folderId' when calling getFolderLists");
|
|
947
|
+
}
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
var pathParams = {
|
|
951
|
+
'folderId': folderId
|
|
952
|
+
};
|
|
953
|
+
var queryParams = {
|
|
954
|
+
'limit': opts['limit'],
|
|
955
|
+
'offset': opts['offset'],
|
|
956
|
+
'sort': opts['sort'],
|
|
957
|
+
};
|
|
958
|
+
var collectionQueryParams = {
|
|
959
|
+
};
|
|
960
|
+
var headerParams = {
|
|
961
|
+
};
|
|
962
|
+
var formParams = {
|
|
963
|
+
};
|
|
964
|
+
|
|
965
|
+
var authNames = ['api-key', 'partner-key'];
|
|
966
|
+
var contentTypes = ['application/json'];
|
|
967
|
+
var accepts = ['application/json'];
|
|
968
|
+
var returnType = GetFolderLists;
|
|
969
|
+
|
|
970
|
+
return this.apiClient.callApi(
|
|
971
|
+
'/contacts/folders/{folderId}/lists', 'GET',
|
|
972
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
973
|
+
authNames, contentTypes, accepts, returnType
|
|
974
|
+
);
|
|
975
|
+
}
|
|
976
|
+
|
|
977
|
+
/**
|
|
978
|
+
* Get lists in a folder
|
|
979
|
+
* @param {Number} folderId Id of the folder
|
|
980
|
+
* @param {Object} opts Optional parameters
|
|
981
|
+
* @param {Number} opts.limit Number of documents per page (default to 10)
|
|
982
|
+
* @param {Number} opts.offset Index of the first document of the page (default to 0)
|
|
983
|
+
* @param {module:model/String} opts.sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
|
984
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetFolderLists}
|
|
985
|
+
*/
|
|
986
|
+
this.getFolderLists = function(folderId, opts) {
|
|
987
|
+
return this.getFolderListsWithHttpInfo(folderId, opts)
|
|
988
|
+
.then(function(response_and_data) {
|
|
989
|
+
return response_and_data.data;
|
|
990
|
+
});
|
|
991
|
+
}
|
|
992
|
+
|
|
993
|
+
|
|
994
|
+
/**
|
|
995
|
+
* Get all folders
|
|
996
|
+
* @param {Number} limit Number of documents per page
|
|
997
|
+
* @param {Number} offset Index of the first document of the page
|
|
998
|
+
* @param {Object} opts Optional parameters
|
|
999
|
+
* @param {module:model/String} opts.sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
|
1000
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetFolders} and HTTP response
|
|
1001
|
+
*/
|
|
1002
|
+
this.getFoldersWithHttpInfo = function(limit, offset, opts) {
|
|
1003
|
+
opts = opts || {};
|
|
1004
|
+
var postBody = null;
|
|
1005
|
+
|
|
1006
|
+
// verify the required parameter 'limit' is set
|
|
1007
|
+
if (limit === undefined || limit === null) {
|
|
1008
|
+
throw new Error("Missing the required parameter 'limit' when calling getFolders");
|
|
1009
|
+
}
|
|
1010
|
+
|
|
1011
|
+
// verify the required parameter 'offset' is set
|
|
1012
|
+
if (offset === undefined || offset === null) {
|
|
1013
|
+
throw new Error("Missing the required parameter 'offset' when calling getFolders");
|
|
1014
|
+
}
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
var pathParams = {
|
|
1018
|
+
};
|
|
1019
|
+
var queryParams = {
|
|
1020
|
+
'limit': limit,
|
|
1021
|
+
'offset': offset,
|
|
1022
|
+
'sort': opts['sort'],
|
|
1023
|
+
};
|
|
1024
|
+
var collectionQueryParams = {
|
|
1025
|
+
};
|
|
1026
|
+
var headerParams = {
|
|
1027
|
+
};
|
|
1028
|
+
var formParams = {
|
|
1029
|
+
};
|
|
1030
|
+
|
|
1031
|
+
var authNames = ['api-key', 'partner-key'];
|
|
1032
|
+
var contentTypes = ['application/json'];
|
|
1033
|
+
var accepts = ['application/json'];
|
|
1034
|
+
var returnType = GetFolders;
|
|
1035
|
+
|
|
1036
|
+
return this.apiClient.callApi(
|
|
1037
|
+
'/contacts/folders', 'GET',
|
|
1038
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
1039
|
+
authNames, contentTypes, accepts, returnType
|
|
1040
|
+
);
|
|
1041
|
+
}
|
|
1042
|
+
|
|
1043
|
+
/**
|
|
1044
|
+
* Get all folders
|
|
1045
|
+
* @param {Number} limit Number of documents per page
|
|
1046
|
+
* @param {Number} offset Index of the first document of the page
|
|
1047
|
+
* @param {Object} opts Optional parameters
|
|
1048
|
+
* @param {module:model/String} opts.sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
|
1049
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetFolders}
|
|
1050
|
+
*/
|
|
1051
|
+
this.getFolders = function(limit, offset, opts) {
|
|
1052
|
+
return this.getFoldersWithHttpInfo(limit, offset, opts)
|
|
1053
|
+
.then(function(response_and_data) {
|
|
1054
|
+
return response_and_data.data;
|
|
1055
|
+
});
|
|
1056
|
+
}
|
|
1057
|
+
|
|
1058
|
+
|
|
1059
|
+
/**
|
|
1060
|
+
* Get a list's details
|
|
1061
|
+
* @param {Number} listId Id of the list
|
|
1062
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetExtendedList} and HTTP response
|
|
1063
|
+
*/
|
|
1064
|
+
this.getListWithHttpInfo = function(listId) {
|
|
1065
|
+
var postBody = null;
|
|
1066
|
+
|
|
1067
|
+
// verify the required parameter 'listId' is set
|
|
1068
|
+
if (listId === undefined || listId === null) {
|
|
1069
|
+
throw new Error("Missing the required parameter 'listId' when calling getList");
|
|
1070
|
+
}
|
|
1071
|
+
|
|
1072
|
+
|
|
1073
|
+
var pathParams = {
|
|
1074
|
+
'listId': listId
|
|
1075
|
+
};
|
|
1076
|
+
var queryParams = {
|
|
1077
|
+
};
|
|
1078
|
+
var collectionQueryParams = {
|
|
1079
|
+
};
|
|
1080
|
+
var headerParams = {
|
|
1081
|
+
};
|
|
1082
|
+
var formParams = {
|
|
1083
|
+
};
|
|
1084
|
+
|
|
1085
|
+
var authNames = ['api-key', 'partner-key'];
|
|
1086
|
+
var contentTypes = ['application/json'];
|
|
1087
|
+
var accepts = ['application/json'];
|
|
1088
|
+
var returnType = GetExtendedList;
|
|
1089
|
+
|
|
1090
|
+
return this.apiClient.callApi(
|
|
1091
|
+
'/contacts/lists/{listId}', 'GET',
|
|
1092
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
1093
|
+
authNames, contentTypes, accepts, returnType
|
|
1094
|
+
);
|
|
1095
|
+
}
|
|
1096
|
+
|
|
1097
|
+
/**
|
|
1098
|
+
* Get a list's details
|
|
1099
|
+
* @param {Number} listId Id of the list
|
|
1100
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetExtendedList}
|
|
1101
|
+
*/
|
|
1102
|
+
this.getList = function(listId) {
|
|
1103
|
+
return this.getListWithHttpInfo(listId)
|
|
1104
|
+
.then(function(response_and_data) {
|
|
1105
|
+
return response_and_data.data;
|
|
1106
|
+
});
|
|
1107
|
+
}
|
|
1108
|
+
|
|
1109
|
+
|
|
1110
|
+
/**
|
|
1111
|
+
* Get all the lists
|
|
1112
|
+
* @param {Object} opts Optional parameters
|
|
1113
|
+
* @param {Number} opts.limit Number of documents per page (default to 10)
|
|
1114
|
+
* @param {Number} opts.offset Index of the first document of the page (default to 0)
|
|
1115
|
+
* @param {module:model/String} opts.sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
|
1116
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetLists} and HTTP response
|
|
1117
|
+
*/
|
|
1118
|
+
this.getListsWithHttpInfo = function(opts) {
|
|
1119
|
+
opts = opts || {};
|
|
1120
|
+
var postBody = null;
|
|
1121
|
+
|
|
1122
|
+
|
|
1123
|
+
var pathParams = {
|
|
1124
|
+
};
|
|
1125
|
+
var queryParams = {
|
|
1126
|
+
'limit': opts['limit'],
|
|
1127
|
+
'offset': opts['offset'],
|
|
1128
|
+
'sort': opts['sort'],
|
|
1129
|
+
};
|
|
1130
|
+
var collectionQueryParams = {
|
|
1131
|
+
};
|
|
1132
|
+
var headerParams = {
|
|
1133
|
+
};
|
|
1134
|
+
var formParams = {
|
|
1135
|
+
};
|
|
1136
|
+
|
|
1137
|
+
var authNames = ['api-key', 'partner-key'];
|
|
1138
|
+
var contentTypes = ['application/json'];
|
|
1139
|
+
var accepts = ['application/json'];
|
|
1140
|
+
var returnType = GetLists;
|
|
1141
|
+
|
|
1142
|
+
return this.apiClient.callApi(
|
|
1143
|
+
'/contacts/lists', 'GET',
|
|
1144
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
1145
|
+
authNames, contentTypes, accepts, returnType
|
|
1146
|
+
);
|
|
1147
|
+
}
|
|
1148
|
+
|
|
1149
|
+
/**
|
|
1150
|
+
* Get all the lists
|
|
1151
|
+
* @param {Object} opts Optional parameters
|
|
1152
|
+
* @param {Number} opts.limit Number of documents per page (default to 10)
|
|
1153
|
+
* @param {Number} opts.offset Index of the first document of the page (default to 0)
|
|
1154
|
+
* @param {module:model/String} opts.sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
|
1155
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetLists}
|
|
1156
|
+
*/
|
|
1157
|
+
this.getLists = function(opts) {
|
|
1158
|
+
return this.getListsWithHttpInfo(opts)
|
|
1159
|
+
.then(function(response_and_data) {
|
|
1160
|
+
return response_and_data.data;
|
|
1161
|
+
});
|
|
1162
|
+
}
|
|
1163
|
+
|
|
1164
|
+
|
|
1165
|
+
/**
|
|
1166
|
+
* Get all the Segments
|
|
1167
|
+
* @param {Number} limit Number of documents per page
|
|
1168
|
+
* @param {Number} offset Index of the first document of the page
|
|
1169
|
+
* @param {Object} opts Optional parameters
|
|
1170
|
+
* @param {module:model/String} opts.sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
|
1171
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetSegments} and HTTP response
|
|
1172
|
+
*/
|
|
1173
|
+
this.getSegmentsWithHttpInfo = function(limit, offset, opts) {
|
|
1174
|
+
opts = opts || {};
|
|
1175
|
+
var postBody = null;
|
|
1176
|
+
|
|
1177
|
+
// verify the required parameter 'limit' is set
|
|
1178
|
+
if (limit === undefined || limit === null) {
|
|
1179
|
+
throw new Error("Missing the required parameter 'limit' when calling getSegments");
|
|
1180
|
+
}
|
|
1181
|
+
|
|
1182
|
+
// verify the required parameter 'offset' is set
|
|
1183
|
+
if (offset === undefined || offset === null) {
|
|
1184
|
+
throw new Error("Missing the required parameter 'offset' when calling getSegments");
|
|
1185
|
+
}
|
|
1186
|
+
|
|
1187
|
+
|
|
1188
|
+
var pathParams = {
|
|
1189
|
+
};
|
|
1190
|
+
var queryParams = {
|
|
1191
|
+
'limit': limit,
|
|
1192
|
+
'offset': offset,
|
|
1193
|
+
'sort': opts['sort'],
|
|
1194
|
+
};
|
|
1195
|
+
var collectionQueryParams = {
|
|
1196
|
+
};
|
|
1197
|
+
var headerParams = {
|
|
1198
|
+
};
|
|
1199
|
+
var formParams = {
|
|
1200
|
+
};
|
|
1201
|
+
|
|
1202
|
+
var authNames = ['api-key', 'partner-key'];
|
|
1203
|
+
var contentTypes = ['application/json'];
|
|
1204
|
+
var accepts = ['application/json'];
|
|
1205
|
+
var returnType = GetSegments;
|
|
1206
|
+
|
|
1207
|
+
return this.apiClient.callApi(
|
|
1208
|
+
'/contacts/segments', 'GET',
|
|
1209
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
1210
|
+
authNames, contentTypes, accepts, returnType
|
|
1211
|
+
);
|
|
1212
|
+
}
|
|
1213
|
+
|
|
1214
|
+
/**
|
|
1215
|
+
* Get all the Segments
|
|
1216
|
+
* @param {Number} limit Number of documents per page
|
|
1217
|
+
* @param {Number} offset Index of the first document of the page
|
|
1218
|
+
* @param {Object} opts Optional parameters
|
|
1219
|
+
* @param {module:model/String} opts.sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
|
1220
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetSegments}
|
|
1221
|
+
*/
|
|
1222
|
+
this.getSegments = function(limit, offset, opts) {
|
|
1223
|
+
return this.getSegmentsWithHttpInfo(limit, offset, opts)
|
|
1224
|
+
.then(function(response_and_data) {
|
|
1225
|
+
return response_and_data.data;
|
|
1226
|
+
});
|
|
1227
|
+
}
|
|
1228
|
+
|
|
1229
|
+
|
|
1230
|
+
/**
|
|
1231
|
+
* Import contacts
|
|
1232
|
+
* It returns the background process ID which on completion calls the notify URL that you have set in the input.
|
|
1233
|
+
* @param {module:model/RequestContactImport} requestContactImport Values to import contacts in Brevo. To know more about the expected format, please have a look at ``https://help.brevo.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns``
|
|
1234
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreatedProcessId} and HTTP response
|
|
1235
|
+
*/
|
|
1236
|
+
this.importContactsWithHttpInfo = function(requestContactImport) {
|
|
1237
|
+
var postBody = requestContactImport;
|
|
1238
|
+
|
|
1239
|
+
// verify the required parameter 'requestContactImport' is set
|
|
1240
|
+
if (requestContactImport === undefined || requestContactImport === null) {
|
|
1241
|
+
throw new Error("Missing the required parameter 'requestContactImport' when calling importContacts");
|
|
1242
|
+
}
|
|
1243
|
+
|
|
1244
|
+
|
|
1245
|
+
var pathParams = {
|
|
1246
|
+
};
|
|
1247
|
+
var queryParams = {
|
|
1248
|
+
};
|
|
1249
|
+
var collectionQueryParams = {
|
|
1250
|
+
};
|
|
1251
|
+
var headerParams = {
|
|
1252
|
+
};
|
|
1253
|
+
var formParams = {
|
|
1254
|
+
};
|
|
1255
|
+
|
|
1256
|
+
var authNames = ['api-key', 'partner-key'];
|
|
1257
|
+
var contentTypes = ['application/json'];
|
|
1258
|
+
var accepts = ['application/json'];
|
|
1259
|
+
var returnType = CreatedProcessId;
|
|
1260
|
+
|
|
1261
|
+
return this.apiClient.callApi(
|
|
1262
|
+
'/contacts/import', 'POST',
|
|
1263
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
1264
|
+
authNames, contentTypes, accepts, returnType
|
|
1265
|
+
);
|
|
1266
|
+
}
|
|
1267
|
+
|
|
1268
|
+
/**
|
|
1269
|
+
* Import contacts
|
|
1270
|
+
* It returns the background process ID which on completion calls the notify URL that you have set in the input.
|
|
1271
|
+
* @param {module:model/RequestContactImport} requestContactImport Values to import contacts in Brevo. To know more about the expected format, please have a look at ``https://help.brevo.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns``
|
|
1272
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreatedProcessId}
|
|
1273
|
+
*/
|
|
1274
|
+
this.importContacts = function(requestContactImport) {
|
|
1275
|
+
return this.importContactsWithHttpInfo(requestContactImport)
|
|
1276
|
+
.then(function(response_and_data) {
|
|
1277
|
+
return response_and_data.data;
|
|
1278
|
+
});
|
|
1279
|
+
}
|
|
1280
|
+
|
|
1281
|
+
|
|
1282
|
+
/**
|
|
1283
|
+
* Delete a contact from a list
|
|
1284
|
+
* @param {Number} listId Id of the list
|
|
1285
|
+
* @param {module:model/RemoveContactFromList} contactEmails Emails addresses OR IDs of the contacts
|
|
1286
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PostContactInfo} and HTTP response
|
|
1287
|
+
*/
|
|
1288
|
+
this.removeContactFromListWithHttpInfo = function(listId, contactEmails) {
|
|
1289
|
+
var postBody = contactEmails;
|
|
1290
|
+
|
|
1291
|
+
// verify the required parameter 'listId' is set
|
|
1292
|
+
if (listId === undefined || listId === null) {
|
|
1293
|
+
throw new Error("Missing the required parameter 'listId' when calling removeContactFromList");
|
|
1294
|
+
}
|
|
1295
|
+
|
|
1296
|
+
// verify the required parameter 'contactEmails' is set
|
|
1297
|
+
if (contactEmails === undefined || contactEmails === null) {
|
|
1298
|
+
throw new Error("Missing the required parameter 'contactEmails' when calling removeContactFromList");
|
|
1299
|
+
}
|
|
1300
|
+
|
|
1301
|
+
|
|
1302
|
+
var pathParams = {
|
|
1303
|
+
'listId': listId
|
|
1304
|
+
};
|
|
1305
|
+
var queryParams = {
|
|
1306
|
+
};
|
|
1307
|
+
var collectionQueryParams = {
|
|
1308
|
+
};
|
|
1309
|
+
var headerParams = {
|
|
1310
|
+
};
|
|
1311
|
+
var formParams = {
|
|
1312
|
+
};
|
|
1313
|
+
|
|
1314
|
+
var authNames = ['api-key', 'partner-key'];
|
|
1315
|
+
var contentTypes = ['application/json'];
|
|
1316
|
+
var accepts = ['application/json'];
|
|
1317
|
+
var returnType = PostContactInfo;
|
|
1318
|
+
|
|
1319
|
+
return this.apiClient.callApi(
|
|
1320
|
+
'/contacts/lists/{listId}/contacts/remove', 'POST',
|
|
1321
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
1322
|
+
authNames, contentTypes, accepts, returnType
|
|
1323
|
+
);
|
|
1324
|
+
}
|
|
1325
|
+
|
|
1326
|
+
/**
|
|
1327
|
+
* Delete a contact from a list
|
|
1328
|
+
* @param {Number} listId Id of the list
|
|
1329
|
+
* @param {module:model/RemoveContactFromList} contactEmails Emails addresses OR IDs of the contacts
|
|
1330
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PostContactInfo}
|
|
1331
|
+
*/
|
|
1332
|
+
this.removeContactFromList = function(listId, contactEmails) {
|
|
1333
|
+
return this.removeContactFromListWithHttpInfo(listId, contactEmails)
|
|
1334
|
+
.then(function(response_and_data) {
|
|
1335
|
+
return response_and_data.data;
|
|
1336
|
+
});
|
|
1337
|
+
}
|
|
1338
|
+
|
|
1339
|
+
|
|
1340
|
+
/**
|
|
1341
|
+
* Export contacts
|
|
1342
|
+
* 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.
|
|
1343
|
+
* @param {module:model/RequestContactExport} requestContactExport Values to request a contact export
|
|
1344
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreatedProcessId} and HTTP response
|
|
1345
|
+
*/
|
|
1346
|
+
this.requestContactExportWithHttpInfo = function(requestContactExport) {
|
|
1347
|
+
var postBody = requestContactExport;
|
|
1348
|
+
|
|
1349
|
+
// verify the required parameter 'requestContactExport' is set
|
|
1350
|
+
if (requestContactExport === undefined || requestContactExport === null) {
|
|
1351
|
+
throw new Error("Missing the required parameter 'requestContactExport' when calling requestContactExport");
|
|
1352
|
+
}
|
|
1353
|
+
|
|
1354
|
+
|
|
1355
|
+
var pathParams = {
|
|
1356
|
+
};
|
|
1357
|
+
var queryParams = {
|
|
1358
|
+
};
|
|
1359
|
+
var collectionQueryParams = {
|
|
1360
|
+
};
|
|
1361
|
+
var headerParams = {
|
|
1362
|
+
};
|
|
1363
|
+
var formParams = {
|
|
1364
|
+
};
|
|
1365
|
+
|
|
1366
|
+
var authNames = ['api-key', 'partner-key'];
|
|
1367
|
+
var contentTypes = ['application/json'];
|
|
1368
|
+
var accepts = ['application/json'];
|
|
1369
|
+
var returnType = CreatedProcessId;
|
|
1370
|
+
|
|
1371
|
+
return this.apiClient.callApi(
|
|
1372
|
+
'/contacts/export', 'POST',
|
|
1373
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
1374
|
+
authNames, contentTypes, accepts, returnType
|
|
1375
|
+
);
|
|
1376
|
+
}
|
|
1377
|
+
|
|
1378
|
+
/**
|
|
1379
|
+
* Export contacts
|
|
1380
|
+
* 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.
|
|
1381
|
+
* @param {module:model/RequestContactExport} requestContactExport Values to request a contact export
|
|
1382
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreatedProcessId}
|
|
1383
|
+
*/
|
|
1384
|
+
this.requestContactExport = function(requestContactExport) {
|
|
1385
|
+
return this.requestContactExportWithHttpInfo(requestContactExport)
|
|
1386
|
+
.then(function(response_and_data) {
|
|
1387
|
+
return response_and_data.data;
|
|
1388
|
+
});
|
|
1389
|
+
}
|
|
1390
|
+
|
|
1391
|
+
|
|
1392
|
+
/**
|
|
1393
|
+
* Update contact attribute
|
|
1394
|
+
* @param {module:model/String} attributeCategory Category of the attribute
|
|
1395
|
+
* @param {String} attributeName Name of the existing attribute
|
|
1396
|
+
* @param {module:model/UpdateAttribute} updateAttribute Values to update an attribute
|
|
1397
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
1398
|
+
*/
|
|
1399
|
+
this.updateAttributeWithHttpInfo = function(attributeCategory, attributeName, updateAttribute) {
|
|
1400
|
+
var postBody = updateAttribute;
|
|
1401
|
+
|
|
1402
|
+
// verify the required parameter 'attributeCategory' is set
|
|
1403
|
+
if (attributeCategory === undefined || attributeCategory === null) {
|
|
1404
|
+
throw new Error("Missing the required parameter 'attributeCategory' when calling updateAttribute");
|
|
1405
|
+
}
|
|
1406
|
+
|
|
1407
|
+
// verify the required parameter 'attributeName' is set
|
|
1408
|
+
if (attributeName === undefined || attributeName === null) {
|
|
1409
|
+
throw new Error("Missing the required parameter 'attributeName' when calling updateAttribute");
|
|
1410
|
+
}
|
|
1411
|
+
|
|
1412
|
+
// verify the required parameter 'updateAttribute' is set
|
|
1413
|
+
if (updateAttribute === undefined || updateAttribute === null) {
|
|
1414
|
+
throw new Error("Missing the required parameter 'updateAttribute' when calling updateAttribute");
|
|
1415
|
+
}
|
|
1416
|
+
|
|
1417
|
+
|
|
1418
|
+
var pathParams = {
|
|
1419
|
+
'attributeCategory': attributeCategory,
|
|
1420
|
+
'attributeName': attributeName
|
|
1421
|
+
};
|
|
1422
|
+
var queryParams = {
|
|
1423
|
+
};
|
|
1424
|
+
var collectionQueryParams = {
|
|
1425
|
+
};
|
|
1426
|
+
var headerParams = {
|
|
1427
|
+
};
|
|
1428
|
+
var formParams = {
|
|
1429
|
+
};
|
|
1430
|
+
|
|
1431
|
+
var authNames = ['api-key', 'partner-key'];
|
|
1432
|
+
var contentTypes = ['application/json'];
|
|
1433
|
+
var accepts = ['application/json'];
|
|
1434
|
+
var returnType = null;
|
|
1435
|
+
|
|
1436
|
+
return this.apiClient.callApi(
|
|
1437
|
+
'/contacts/attributes/{attributeCategory}/{attributeName}', 'PUT',
|
|
1438
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
1439
|
+
authNames, contentTypes, accepts, returnType
|
|
1440
|
+
);
|
|
1441
|
+
}
|
|
1442
|
+
|
|
1443
|
+
/**
|
|
1444
|
+
* Update contact attribute
|
|
1445
|
+
* @param {module:model/String} attributeCategory Category of the attribute
|
|
1446
|
+
* @param {String} attributeName Name of the existing attribute
|
|
1447
|
+
* @param {module:model/UpdateAttribute} updateAttribute Values to update an attribute
|
|
1448
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
1449
|
+
*/
|
|
1450
|
+
this.updateAttribute = function(attributeCategory, attributeName, updateAttribute) {
|
|
1451
|
+
return this.updateAttributeWithHttpInfo(attributeCategory, attributeName, updateAttribute)
|
|
1452
|
+
.then(function(response_and_data) {
|
|
1453
|
+
return response_and_data.data;
|
|
1454
|
+
});
|
|
1455
|
+
}
|
|
1456
|
+
|
|
1457
|
+
|
|
1458
|
+
/**
|
|
1459
|
+
* Update multiple contacts
|
|
1460
|
+
* @param {module:model/UpdateBatchContacts} updateBatchContacts Values to update multiple contacts
|
|
1461
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
1462
|
+
*/
|
|
1463
|
+
this.updateBatchContactsWithHttpInfo = function(updateBatchContacts) {
|
|
1464
|
+
var postBody = updateBatchContacts;
|
|
1465
|
+
|
|
1466
|
+
// verify the required parameter 'updateBatchContacts' is set
|
|
1467
|
+
if (updateBatchContacts === undefined || updateBatchContacts === null) {
|
|
1468
|
+
throw new Error("Missing the required parameter 'updateBatchContacts' when calling updateBatchContacts");
|
|
1469
|
+
}
|
|
1470
|
+
|
|
1471
|
+
|
|
1472
|
+
var pathParams = {
|
|
1473
|
+
};
|
|
1474
|
+
var queryParams = {
|
|
1475
|
+
};
|
|
1476
|
+
var collectionQueryParams = {
|
|
1477
|
+
};
|
|
1478
|
+
var headerParams = {
|
|
1479
|
+
};
|
|
1480
|
+
var formParams = {
|
|
1481
|
+
};
|
|
1482
|
+
|
|
1483
|
+
var authNames = ['api-key', 'partner-key'];
|
|
1484
|
+
var contentTypes = ['application/json'];
|
|
1485
|
+
var accepts = ['application/json'];
|
|
1486
|
+
var returnType = null;
|
|
1487
|
+
|
|
1488
|
+
return this.apiClient.callApi(
|
|
1489
|
+
'/contacts/batch', 'POST',
|
|
1490
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
1491
|
+
authNames, contentTypes, accepts, returnType
|
|
1492
|
+
);
|
|
1493
|
+
}
|
|
1494
|
+
|
|
1495
|
+
/**
|
|
1496
|
+
* Update multiple contacts
|
|
1497
|
+
* @param {module:model/UpdateBatchContacts} updateBatchContacts Values to update multiple contacts
|
|
1498
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
1499
|
+
*/
|
|
1500
|
+
this.updateBatchContacts = function(updateBatchContacts) {
|
|
1501
|
+
return this.updateBatchContactsWithHttpInfo(updateBatchContacts)
|
|
1502
|
+
.then(function(response_and_data) {
|
|
1503
|
+
return response_and_data.data;
|
|
1504
|
+
});
|
|
1505
|
+
}
|
|
1506
|
+
|
|
1507
|
+
|
|
1508
|
+
/**
|
|
1509
|
+
* Update a contact
|
|
1510
|
+
* @param {String} identifier Email (urlencoded) OR ID of the contact
|
|
1511
|
+
* @param {module:model/UpdateContact} updateContact Values to update a contact
|
|
1512
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
1513
|
+
*/
|
|
1514
|
+
this.updateContactWithHttpInfo = function(identifier, updateContact) {
|
|
1515
|
+
var postBody = updateContact;
|
|
1516
|
+
|
|
1517
|
+
// verify the required parameter 'identifier' is set
|
|
1518
|
+
if (identifier === undefined || identifier === null) {
|
|
1519
|
+
throw new Error("Missing the required parameter 'identifier' when calling updateContact");
|
|
1520
|
+
}
|
|
1521
|
+
|
|
1522
|
+
// verify the required parameter 'updateContact' is set
|
|
1523
|
+
if (updateContact === undefined || updateContact === null) {
|
|
1524
|
+
throw new Error("Missing the required parameter 'updateContact' when calling updateContact");
|
|
1525
|
+
}
|
|
1526
|
+
|
|
1527
|
+
|
|
1528
|
+
var pathParams = {
|
|
1529
|
+
'identifier': identifier
|
|
1530
|
+
};
|
|
1531
|
+
var queryParams = {
|
|
1532
|
+
};
|
|
1533
|
+
var collectionQueryParams = {
|
|
1534
|
+
};
|
|
1535
|
+
var headerParams = {
|
|
1536
|
+
};
|
|
1537
|
+
var formParams = {
|
|
1538
|
+
};
|
|
1539
|
+
|
|
1540
|
+
var authNames = ['api-key', 'partner-key'];
|
|
1541
|
+
var contentTypes = ['application/json'];
|
|
1542
|
+
var accepts = ['application/json'];
|
|
1543
|
+
var returnType = null;
|
|
1544
|
+
|
|
1545
|
+
return this.apiClient.callApi(
|
|
1546
|
+
'/contacts/{identifier}', 'PUT',
|
|
1547
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
1548
|
+
authNames, contentTypes, accepts, returnType
|
|
1549
|
+
);
|
|
1550
|
+
}
|
|
1551
|
+
|
|
1552
|
+
/**
|
|
1553
|
+
* Update a contact
|
|
1554
|
+
* @param {String} identifier Email (urlencoded) OR ID of the contact
|
|
1555
|
+
* @param {module:model/UpdateContact} updateContact Values to update a contact
|
|
1556
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
1557
|
+
*/
|
|
1558
|
+
this.updateContact = function(identifier, updateContact) {
|
|
1559
|
+
return this.updateContactWithHttpInfo(identifier, updateContact)
|
|
1560
|
+
.then(function(response_and_data) {
|
|
1561
|
+
return response_and_data.data;
|
|
1562
|
+
});
|
|
1563
|
+
}
|
|
1564
|
+
|
|
1565
|
+
|
|
1566
|
+
/**
|
|
1567
|
+
* Update a folder
|
|
1568
|
+
* @param {Number} folderId Id of the folder
|
|
1569
|
+
* @param {module:model/CreateUpdateFolder} updateFolder Name of the folder
|
|
1570
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
1571
|
+
*/
|
|
1572
|
+
this.updateFolderWithHttpInfo = function(folderId, updateFolder) {
|
|
1573
|
+
var postBody = updateFolder;
|
|
1574
|
+
|
|
1575
|
+
// verify the required parameter 'folderId' is set
|
|
1576
|
+
if (folderId === undefined || folderId === null) {
|
|
1577
|
+
throw new Error("Missing the required parameter 'folderId' when calling updateFolder");
|
|
1578
|
+
}
|
|
1579
|
+
|
|
1580
|
+
// verify the required parameter 'updateFolder' is set
|
|
1581
|
+
if (updateFolder === undefined || updateFolder === null) {
|
|
1582
|
+
throw new Error("Missing the required parameter 'updateFolder' when calling updateFolder");
|
|
1583
|
+
}
|
|
1584
|
+
|
|
1585
|
+
|
|
1586
|
+
var pathParams = {
|
|
1587
|
+
'folderId': folderId
|
|
1588
|
+
};
|
|
1589
|
+
var queryParams = {
|
|
1590
|
+
};
|
|
1591
|
+
var collectionQueryParams = {
|
|
1592
|
+
};
|
|
1593
|
+
var headerParams = {
|
|
1594
|
+
};
|
|
1595
|
+
var formParams = {
|
|
1596
|
+
};
|
|
1597
|
+
|
|
1598
|
+
var authNames = ['api-key', 'partner-key'];
|
|
1599
|
+
var contentTypes = ['application/json'];
|
|
1600
|
+
var accepts = ['application/json'];
|
|
1601
|
+
var returnType = null;
|
|
1602
|
+
|
|
1603
|
+
return this.apiClient.callApi(
|
|
1604
|
+
'/contacts/folders/{folderId}', 'PUT',
|
|
1605
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
1606
|
+
authNames, contentTypes, accepts, returnType
|
|
1607
|
+
);
|
|
1608
|
+
}
|
|
1609
|
+
|
|
1610
|
+
/**
|
|
1611
|
+
* Update a folder
|
|
1612
|
+
* @param {Number} folderId Id of the folder
|
|
1613
|
+
* @param {module:model/CreateUpdateFolder} updateFolder Name of the folder
|
|
1614
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
1615
|
+
*/
|
|
1616
|
+
this.updateFolder = function(folderId, updateFolder) {
|
|
1617
|
+
return this.updateFolderWithHttpInfo(folderId, updateFolder)
|
|
1618
|
+
.then(function(response_and_data) {
|
|
1619
|
+
return response_and_data.data;
|
|
1620
|
+
});
|
|
1621
|
+
}
|
|
1622
|
+
|
|
1623
|
+
|
|
1624
|
+
/**
|
|
1625
|
+
* Update a list
|
|
1626
|
+
* @param {Number} listId Id of the list
|
|
1627
|
+
* @param {module:model/UpdateList} updateList Values to update a list
|
|
1628
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
1629
|
+
*/
|
|
1630
|
+
this.updateListWithHttpInfo = function(listId, updateList) {
|
|
1631
|
+
var postBody = updateList;
|
|
1632
|
+
|
|
1633
|
+
// verify the required parameter 'listId' is set
|
|
1634
|
+
if (listId === undefined || listId === null) {
|
|
1635
|
+
throw new Error("Missing the required parameter 'listId' when calling updateList");
|
|
1636
|
+
}
|
|
1637
|
+
|
|
1638
|
+
// verify the required parameter 'updateList' is set
|
|
1639
|
+
if (updateList === undefined || updateList === null) {
|
|
1640
|
+
throw new Error("Missing the required parameter 'updateList' when calling updateList");
|
|
1641
|
+
}
|
|
1642
|
+
|
|
1643
|
+
|
|
1644
|
+
var pathParams = {
|
|
1645
|
+
'listId': listId
|
|
1646
|
+
};
|
|
1647
|
+
var queryParams = {
|
|
1648
|
+
};
|
|
1649
|
+
var collectionQueryParams = {
|
|
1650
|
+
};
|
|
1651
|
+
var headerParams = {
|
|
1652
|
+
};
|
|
1653
|
+
var formParams = {
|
|
1654
|
+
};
|
|
1655
|
+
|
|
1656
|
+
var authNames = ['api-key', 'partner-key'];
|
|
1657
|
+
var contentTypes = ['application/json'];
|
|
1658
|
+
var accepts = ['application/json'];
|
|
1659
|
+
var returnType = null;
|
|
1660
|
+
|
|
1661
|
+
return this.apiClient.callApi(
|
|
1662
|
+
'/contacts/lists/{listId}', 'PUT',
|
|
1663
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
1664
|
+
authNames, contentTypes, accepts, returnType
|
|
1665
|
+
);
|
|
1666
|
+
}
|
|
1667
|
+
|
|
1668
|
+
/**
|
|
1669
|
+
* Update a list
|
|
1670
|
+
* @param {Number} listId Id of the list
|
|
1671
|
+
* @param {module:model/UpdateList} updateList Values to update a list
|
|
1672
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
1673
|
+
*/
|
|
1674
|
+
this.updateList = function(listId, updateList) {
|
|
1675
|
+
return this.updateListWithHttpInfo(listId, updateList)
|
|
1676
|
+
.then(function(response_and_data) {
|
|
1677
|
+
return response_and_data.data;
|
|
1678
|
+
});
|
|
1679
|
+
}
|
|
1680
|
+
};
|
|
1681
|
+
|
|
1682
|
+
return exports;
|
|
1683
|
+
}));
|