@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,295 @@
|
|
|
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/ErrorModel', 'model/GetSmsEventReport', 'model/GetTransacAggregatedSmsReport', 'model/GetTransacSmsReport', 'model/SendSms', 'model/SendTransacSms'], 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/ErrorModel'), require('../model/GetSmsEventReport'), require('../model/GetTransacAggregatedSmsReport'), require('../model/GetTransacSmsReport'), require('../model/SendSms'), require('../model/SendTransacSms'));
|
|
24
|
+
} else {
|
|
25
|
+
// Browser globals (root is window)
|
|
26
|
+
if (!root.Brevo) {
|
|
27
|
+
root.Brevo = {};
|
|
28
|
+
}
|
|
29
|
+
root.Brevo.TransactionalSMSApi = factory(root.Brevo.ApiClient, root.Brevo.ErrorModel, root.Brevo.GetSmsEventReport, root.Brevo.GetTransacAggregatedSmsReport, root.Brevo.GetTransacSmsReport, root.Brevo.SendSms, root.Brevo.SendTransacSms);
|
|
30
|
+
}
|
|
31
|
+
}(this, function(ApiClient, ErrorModel, GetSmsEventReport, GetTransacAggregatedSmsReport, GetTransacSmsReport, SendSms, SendTransacSms) {
|
|
32
|
+
'use strict';
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* TransactionalSMS service.
|
|
36
|
+
* @module api/TransactionalSMSApi
|
|
37
|
+
* @version 1.0.0
|
|
38
|
+
*/
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* Constructs a new TransactionalSMSApi.
|
|
42
|
+
* @alias module:api/TransactionalSMSApi
|
|
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
|
+
* Get all your SMS activity (unaggregated events)
|
|
54
|
+
* @param {Object} opts Optional parameters
|
|
55
|
+
* @param {Number} opts.limit Number of documents per page (default to 50)
|
|
56
|
+
* @param {String} opts.startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
|
57
|
+
* @param {String} opts.endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
|
58
|
+
* @param {Number} opts.offset Index of the first document of the page (default to 0)
|
|
59
|
+
* @param {Number} opts.days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
|
60
|
+
* @param {String} opts.phoneNumber Filter the report for a specific phone number
|
|
61
|
+
* @param {module:model/String} opts.event Filter the report for specific events
|
|
62
|
+
* @param {String} opts.tags Filter the report for specific tags passed as a serialized urlencoded array
|
|
63
|
+
* @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)
|
|
64
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetSmsEventReport} and HTTP response
|
|
65
|
+
*/
|
|
66
|
+
this.getSmsEventsWithHttpInfo = function(opts) {
|
|
67
|
+
opts = opts || {};
|
|
68
|
+
var postBody = null;
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
var pathParams = {
|
|
72
|
+
};
|
|
73
|
+
var queryParams = {
|
|
74
|
+
'limit': opts['limit'],
|
|
75
|
+
'startDate': opts['startDate'],
|
|
76
|
+
'endDate': opts['endDate'],
|
|
77
|
+
'offset': opts['offset'],
|
|
78
|
+
'days': opts['days'],
|
|
79
|
+
'phoneNumber': opts['phoneNumber'],
|
|
80
|
+
'event': opts['event'],
|
|
81
|
+
'tags': opts['tags'],
|
|
82
|
+
'sort': opts['sort'],
|
|
83
|
+
};
|
|
84
|
+
var collectionQueryParams = {
|
|
85
|
+
};
|
|
86
|
+
var headerParams = {
|
|
87
|
+
};
|
|
88
|
+
var formParams = {
|
|
89
|
+
};
|
|
90
|
+
|
|
91
|
+
var authNames = ['api-key', 'partner-key'];
|
|
92
|
+
var contentTypes = ['application/json'];
|
|
93
|
+
var accepts = ['application/json'];
|
|
94
|
+
var returnType = GetSmsEventReport;
|
|
95
|
+
|
|
96
|
+
return this.apiClient.callApi(
|
|
97
|
+
'/transactionalSMS/statistics/events', 'GET',
|
|
98
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
99
|
+
authNames, contentTypes, accepts, returnType
|
|
100
|
+
);
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
/**
|
|
104
|
+
* Get all your SMS activity (unaggregated events)
|
|
105
|
+
* @param {Object} opts Optional parameters
|
|
106
|
+
* @param {Number} opts.limit Number of documents per page (default to 50)
|
|
107
|
+
* @param {String} opts.startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
|
108
|
+
* @param {String} opts.endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
|
109
|
+
* @param {Number} opts.offset Index of the first document of the page (default to 0)
|
|
110
|
+
* @param {Number} opts.days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
|
111
|
+
* @param {String} opts.phoneNumber Filter the report for a specific phone number
|
|
112
|
+
* @param {module:model/String} opts.event Filter the report for specific events
|
|
113
|
+
* @param {String} opts.tags Filter the report for specific tags passed as a serialized urlencoded array
|
|
114
|
+
* @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)
|
|
115
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetSmsEventReport}
|
|
116
|
+
*/
|
|
117
|
+
this.getSmsEvents = function(opts) {
|
|
118
|
+
return this.getSmsEventsWithHttpInfo(opts)
|
|
119
|
+
.then(function(response_and_data) {
|
|
120
|
+
return response_and_data.data;
|
|
121
|
+
});
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
/**
|
|
126
|
+
* Get your SMS activity aggregated over a period of time
|
|
127
|
+
* @param {Object} opts Optional parameters
|
|
128
|
+
* @param {String} opts.startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
|
129
|
+
* @param {String} opts.endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
|
130
|
+
* @param {Number} opts.days Number of days in the past including today (positive integer). Not compatible with startDate and endDate
|
|
131
|
+
* @param {String} opts.tag Filter on a tag
|
|
132
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetTransacAggregatedSmsReport} and HTTP response
|
|
133
|
+
*/
|
|
134
|
+
this.getTransacAggregatedSmsReportWithHttpInfo = function(opts) {
|
|
135
|
+
opts = opts || {};
|
|
136
|
+
var postBody = null;
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
var pathParams = {
|
|
140
|
+
};
|
|
141
|
+
var queryParams = {
|
|
142
|
+
'startDate': opts['startDate'],
|
|
143
|
+
'endDate': opts['endDate'],
|
|
144
|
+
'days': opts['days'],
|
|
145
|
+
'tag': opts['tag'],
|
|
146
|
+
};
|
|
147
|
+
var collectionQueryParams = {
|
|
148
|
+
};
|
|
149
|
+
var headerParams = {
|
|
150
|
+
};
|
|
151
|
+
var formParams = {
|
|
152
|
+
};
|
|
153
|
+
|
|
154
|
+
var authNames = ['api-key', 'partner-key'];
|
|
155
|
+
var contentTypes = ['application/json'];
|
|
156
|
+
var accepts = ['application/json'];
|
|
157
|
+
var returnType = GetTransacAggregatedSmsReport;
|
|
158
|
+
|
|
159
|
+
return this.apiClient.callApi(
|
|
160
|
+
'/transactionalSMS/statistics/aggregatedReport', 'GET',
|
|
161
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
162
|
+
authNames, contentTypes, accepts, returnType
|
|
163
|
+
);
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
/**
|
|
167
|
+
* Get your SMS activity aggregated over a period of time
|
|
168
|
+
* @param {Object} opts Optional parameters
|
|
169
|
+
* @param {String} opts.startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
|
170
|
+
* @param {String} opts.endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
|
171
|
+
* @param {Number} opts.days Number of days in the past including today (positive integer). Not compatible with startDate and endDate
|
|
172
|
+
* @param {String} opts.tag Filter on a tag
|
|
173
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetTransacAggregatedSmsReport}
|
|
174
|
+
*/
|
|
175
|
+
this.getTransacAggregatedSmsReport = function(opts) {
|
|
176
|
+
return this.getTransacAggregatedSmsReportWithHttpInfo(opts)
|
|
177
|
+
.then(function(response_and_data) {
|
|
178
|
+
return response_and_data.data;
|
|
179
|
+
});
|
|
180
|
+
}
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
/**
|
|
184
|
+
* Get your SMS activity aggregated per day
|
|
185
|
+
* @param {Object} opts Optional parameters
|
|
186
|
+
* @param {String} opts.startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
|
187
|
+
* @param {String} opts.endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
|
188
|
+
* @param {Number} opts.days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
|
189
|
+
* @param {String} opts.tag Filter on a tag
|
|
190
|
+
* @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)
|
|
191
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetTransacSmsReport} and HTTP response
|
|
192
|
+
*/
|
|
193
|
+
this.getTransacSmsReportWithHttpInfo = function(opts) {
|
|
194
|
+
opts = opts || {};
|
|
195
|
+
var postBody = null;
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
var pathParams = {
|
|
199
|
+
};
|
|
200
|
+
var queryParams = {
|
|
201
|
+
'startDate': opts['startDate'],
|
|
202
|
+
'endDate': opts['endDate'],
|
|
203
|
+
'days': opts['days'],
|
|
204
|
+
'tag': opts['tag'],
|
|
205
|
+
'sort': opts['sort'],
|
|
206
|
+
};
|
|
207
|
+
var collectionQueryParams = {
|
|
208
|
+
};
|
|
209
|
+
var headerParams = {
|
|
210
|
+
};
|
|
211
|
+
var formParams = {
|
|
212
|
+
};
|
|
213
|
+
|
|
214
|
+
var authNames = ['api-key', 'partner-key'];
|
|
215
|
+
var contentTypes = ['application/json'];
|
|
216
|
+
var accepts = ['application/json'];
|
|
217
|
+
var returnType = GetTransacSmsReport;
|
|
218
|
+
|
|
219
|
+
return this.apiClient.callApi(
|
|
220
|
+
'/transactionalSMS/statistics/reports', 'GET',
|
|
221
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
222
|
+
authNames, contentTypes, accepts, returnType
|
|
223
|
+
);
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
/**
|
|
227
|
+
* Get your SMS activity aggregated per day
|
|
228
|
+
* @param {Object} opts Optional parameters
|
|
229
|
+
* @param {String} opts.startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
|
230
|
+
* @param {String} opts.endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
|
231
|
+
* @param {Number} opts.days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
|
232
|
+
* @param {String} opts.tag Filter on a tag
|
|
233
|
+
* @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)
|
|
234
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetTransacSmsReport}
|
|
235
|
+
*/
|
|
236
|
+
this.getTransacSmsReport = function(opts) {
|
|
237
|
+
return this.getTransacSmsReportWithHttpInfo(opts)
|
|
238
|
+
.then(function(response_and_data) {
|
|
239
|
+
return response_and_data.data;
|
|
240
|
+
});
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
/**
|
|
245
|
+
* Send SMS message to a mobile number
|
|
246
|
+
* @param {module:model/SendTransacSms} sendTransacSms Values to send a transactional SMS
|
|
247
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendSms} and HTTP response
|
|
248
|
+
*/
|
|
249
|
+
this.sendTransacSmsWithHttpInfo = function(sendTransacSms) {
|
|
250
|
+
var postBody = sendTransacSms;
|
|
251
|
+
|
|
252
|
+
// verify the required parameter 'sendTransacSms' is set
|
|
253
|
+
if (sendTransacSms === undefined || sendTransacSms === null) {
|
|
254
|
+
throw new Error("Missing the required parameter 'sendTransacSms' when calling sendTransacSms");
|
|
255
|
+
}
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
var pathParams = {
|
|
259
|
+
};
|
|
260
|
+
var queryParams = {
|
|
261
|
+
};
|
|
262
|
+
var collectionQueryParams = {
|
|
263
|
+
};
|
|
264
|
+
var headerParams = {
|
|
265
|
+
};
|
|
266
|
+
var formParams = {
|
|
267
|
+
};
|
|
268
|
+
|
|
269
|
+
var authNames = ['api-key', 'partner-key'];
|
|
270
|
+
var contentTypes = ['application/json'];
|
|
271
|
+
var accepts = ['application/json'];
|
|
272
|
+
var returnType = SendSms;
|
|
273
|
+
|
|
274
|
+
return this.apiClient.callApi(
|
|
275
|
+
'/transactionalSMS/sms', 'POST',
|
|
276
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
277
|
+
authNames, contentTypes, accepts, returnType
|
|
278
|
+
);
|
|
279
|
+
}
|
|
280
|
+
|
|
281
|
+
/**
|
|
282
|
+
* Send SMS message to a mobile number
|
|
283
|
+
* @param {module:model/SendTransacSms} sendTransacSms Values to send a transactional SMS
|
|
284
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendSms}
|
|
285
|
+
*/
|
|
286
|
+
this.sendTransacSms = function(sendTransacSms) {
|
|
287
|
+
return this.sendTransacSmsWithHttpInfo(sendTransacSms)
|
|
288
|
+
.then(function(response_and_data) {
|
|
289
|
+
return response_and_data.data;
|
|
290
|
+
});
|
|
291
|
+
}
|
|
292
|
+
};
|
|
293
|
+
|
|
294
|
+
return exports;
|
|
295
|
+
}));
|
|
@@ -0,0 +1,177 @@
|
|
|
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/ErrorModel', 'model/GetWhatsappEventReport', 'model/InlineResponse2013', 'model/SendWhatsappMessage'], 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/ErrorModel'), require('../model/GetWhatsappEventReport'), require('../model/InlineResponse2013'), require('../model/SendWhatsappMessage'));
|
|
24
|
+
} else {
|
|
25
|
+
// Browser globals (root is window)
|
|
26
|
+
if (!root.Brevo) {
|
|
27
|
+
root.Brevo = {};
|
|
28
|
+
}
|
|
29
|
+
root.Brevo.TransactionalWhatsAppApi = factory(root.Brevo.ApiClient, root.Brevo.ErrorModel, root.Brevo.GetWhatsappEventReport, root.Brevo.InlineResponse2013, root.Brevo.SendWhatsappMessage);
|
|
30
|
+
}
|
|
31
|
+
}(this, function(ApiClient, ErrorModel, GetWhatsappEventReport, InlineResponse2013, SendWhatsappMessage) {
|
|
32
|
+
'use strict';
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* TransactionalWhatsApp service.
|
|
36
|
+
* @module api/TransactionalWhatsAppApi
|
|
37
|
+
* @version 1.0.0
|
|
38
|
+
*/
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* Constructs a new TransactionalWhatsAppApi.
|
|
42
|
+
* @alias module:api/TransactionalWhatsAppApi
|
|
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
|
+
* Get all your WhatsApp activity (unaggregated events)
|
|
54
|
+
* This endpoint will show the unaggregated statistics for WhatsApp activity (30 days by default if `startDate` and `endDate` or `days` is not passed. The date range can not exceed 90 days)
|
|
55
|
+
* @param {Object} opts Optional parameters
|
|
56
|
+
* @param {Number} opts.limit Number limitation for the result returned (default to 2500)
|
|
57
|
+
* @param {Number} opts.offset Beginning point in the list to retrieve from (default to 0)
|
|
58
|
+
* @param {String} opts.startDate **Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
|
59
|
+
* @param {String} opts.endDate **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
|
60
|
+
* @param {Number} opts.days Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_
|
|
61
|
+
* @param {String} opts.contactNumber Filter results for specific contact (WhatsApp Number with country code. Example, 85264318721)
|
|
62
|
+
* @param {module:model/String} opts.event Filter the report for a specific event type
|
|
63
|
+
* @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)
|
|
64
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetWhatsappEventReport} and HTTP response
|
|
65
|
+
*/
|
|
66
|
+
this.getWhatsappEventReportWithHttpInfo = function(opts) {
|
|
67
|
+
opts = opts || {};
|
|
68
|
+
var postBody = null;
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
var pathParams = {
|
|
72
|
+
};
|
|
73
|
+
var queryParams = {
|
|
74
|
+
'limit': opts['limit'],
|
|
75
|
+
'offset': opts['offset'],
|
|
76
|
+
'startDate': opts['startDate'],
|
|
77
|
+
'endDate': opts['endDate'],
|
|
78
|
+
'days': opts['days'],
|
|
79
|
+
'contactNumber': opts['contactNumber'],
|
|
80
|
+
'event': opts['event'],
|
|
81
|
+
'sort': opts['sort'],
|
|
82
|
+
};
|
|
83
|
+
var collectionQueryParams = {
|
|
84
|
+
};
|
|
85
|
+
var headerParams = {
|
|
86
|
+
};
|
|
87
|
+
var formParams = {
|
|
88
|
+
};
|
|
89
|
+
|
|
90
|
+
var authNames = ['api-key', 'partner-key'];
|
|
91
|
+
var contentTypes = ['application/json'];
|
|
92
|
+
var accepts = ['application/json'];
|
|
93
|
+
var returnType = GetWhatsappEventReport;
|
|
94
|
+
|
|
95
|
+
return this.apiClient.callApi(
|
|
96
|
+
'/whatsapp/statistics/events', 'GET',
|
|
97
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
98
|
+
authNames, contentTypes, accepts, returnType
|
|
99
|
+
);
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
/**
|
|
103
|
+
* Get all your WhatsApp activity (unaggregated events)
|
|
104
|
+
* This endpoint will show the unaggregated statistics for WhatsApp activity (30 days by default if `startDate` and `endDate` or `days` is not passed. The date range can not exceed 90 days)
|
|
105
|
+
* @param {Object} opts Optional parameters
|
|
106
|
+
* @param {Number} opts.limit Number limitation for the result returned (default to 2500)
|
|
107
|
+
* @param {Number} opts.offset Beginning point in the list to retrieve from (default to 0)
|
|
108
|
+
* @param {String} opts.startDate **Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
|
109
|
+
* @param {String} opts.endDate **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
|
110
|
+
* @param {Number} opts.days Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_
|
|
111
|
+
* @param {String} opts.contactNumber Filter results for specific contact (WhatsApp Number with country code. Example, 85264318721)
|
|
112
|
+
* @param {module:model/String} opts.event Filter the report for a specific event type
|
|
113
|
+
* @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)
|
|
114
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetWhatsappEventReport}
|
|
115
|
+
*/
|
|
116
|
+
this.getWhatsappEventReport = function(opts) {
|
|
117
|
+
return this.getWhatsappEventReportWithHttpInfo(opts)
|
|
118
|
+
.then(function(response_and_data) {
|
|
119
|
+
return response_and_data.data;
|
|
120
|
+
});
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
/**
|
|
125
|
+
* Send a WhatsApp message
|
|
126
|
+
* This endpoint is used to send a WhatsApp message. <br/>(**The first message you send using the API must contain a Template ID. You must create a template on WhatsApp on the Brevo platform to fetch the Template ID.**)
|
|
127
|
+
* @param {module:model/SendWhatsappMessage} sendWhatsappMessage Values to send WhatsApp message
|
|
128
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2013} and HTTP response
|
|
129
|
+
*/
|
|
130
|
+
this.sendWhatsappMessageWithHttpInfo = function(sendWhatsappMessage) {
|
|
131
|
+
var postBody = sendWhatsappMessage;
|
|
132
|
+
|
|
133
|
+
// verify the required parameter 'sendWhatsappMessage' is set
|
|
134
|
+
if (sendWhatsappMessage === undefined || sendWhatsappMessage === null) {
|
|
135
|
+
throw new Error("Missing the required parameter 'sendWhatsappMessage' when calling sendWhatsappMessage");
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
var pathParams = {
|
|
140
|
+
};
|
|
141
|
+
var queryParams = {
|
|
142
|
+
};
|
|
143
|
+
var collectionQueryParams = {
|
|
144
|
+
};
|
|
145
|
+
var headerParams = {
|
|
146
|
+
};
|
|
147
|
+
var formParams = {
|
|
148
|
+
};
|
|
149
|
+
|
|
150
|
+
var authNames = ['api-key', 'partner-key'];
|
|
151
|
+
var contentTypes = ['application/json'];
|
|
152
|
+
var accepts = ['application/json'];
|
|
153
|
+
var returnType = InlineResponse2013;
|
|
154
|
+
|
|
155
|
+
return this.apiClient.callApi(
|
|
156
|
+
'/whatsapp/sendMessage', 'POST',
|
|
157
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
158
|
+
authNames, contentTypes, accepts, returnType
|
|
159
|
+
);
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
/**
|
|
163
|
+
* Send a WhatsApp message
|
|
164
|
+
* This endpoint is used to send a WhatsApp message. <br/>(**The first message you send using the API must contain a Template ID. You must create a template on WhatsApp on the Brevo platform to fetch the Template ID.**)
|
|
165
|
+
* @param {module:model/SendWhatsappMessage} sendWhatsappMessage Values to send WhatsApp message
|
|
166
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2013}
|
|
167
|
+
*/
|
|
168
|
+
this.sendWhatsappMessage = function(sendWhatsappMessage) {
|
|
169
|
+
return this.sendWhatsappMessageWithHttpInfo(sendWhatsappMessage)
|
|
170
|
+
.then(function(response_and_data) {
|
|
171
|
+
return response_and_data.data;
|
|
172
|
+
});
|
|
173
|
+
}
|
|
174
|
+
};
|
|
175
|
+
|
|
176
|
+
return exports;
|
|
177
|
+
}));
|
|
@@ -0,0 +1,147 @@
|
|
|
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/ErrorModel', 'model/GetInvitedUsersList', 'model/GetUserPermission'], 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/ErrorModel'), require('../model/GetInvitedUsersList'), require('../model/GetUserPermission'));
|
|
24
|
+
} else {
|
|
25
|
+
// Browser globals (root is window)
|
|
26
|
+
if (!root.Brevo) {
|
|
27
|
+
root.Brevo = {};
|
|
28
|
+
}
|
|
29
|
+
root.Brevo.UserApi = factory(root.Brevo.ApiClient, root.Brevo.ErrorModel, root.Brevo.GetInvitedUsersList, root.Brevo.GetUserPermission);
|
|
30
|
+
}
|
|
31
|
+
}(this, function(ApiClient, ErrorModel, GetInvitedUsersList, GetUserPermission) {
|
|
32
|
+
'use strict';
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* User service.
|
|
36
|
+
* @module api/UserApi
|
|
37
|
+
* @version 1.0.0
|
|
38
|
+
*/
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* Constructs a new UserApi.
|
|
42
|
+
* @alias module:api/UserApi
|
|
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
|
+
* Get the list of all your users
|
|
54
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetInvitedUsersList} and HTTP response
|
|
55
|
+
*/
|
|
56
|
+
this.getInvitedUsersListWithHttpInfo = function() {
|
|
57
|
+
var postBody = null;
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
var pathParams = {
|
|
61
|
+
};
|
|
62
|
+
var queryParams = {
|
|
63
|
+
};
|
|
64
|
+
var collectionQueryParams = {
|
|
65
|
+
};
|
|
66
|
+
var headerParams = {
|
|
67
|
+
};
|
|
68
|
+
var formParams = {
|
|
69
|
+
};
|
|
70
|
+
|
|
71
|
+
var authNames = ['api-key', 'partner-key'];
|
|
72
|
+
var contentTypes = ['application/json'];
|
|
73
|
+
var accepts = ['application/json'];
|
|
74
|
+
var returnType = GetInvitedUsersList;
|
|
75
|
+
|
|
76
|
+
return this.apiClient.callApi(
|
|
77
|
+
'/organization/invited/users', 'GET',
|
|
78
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
79
|
+
authNames, contentTypes, accepts, returnType
|
|
80
|
+
);
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
/**
|
|
84
|
+
* Get the list of all your users
|
|
85
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetInvitedUsersList}
|
|
86
|
+
*/
|
|
87
|
+
this.getInvitedUsersList = function() {
|
|
88
|
+
return this.getInvitedUsersListWithHttpInfo()
|
|
89
|
+
.then(function(response_and_data) {
|
|
90
|
+
return response_and_data.data;
|
|
91
|
+
});
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
/**
|
|
96
|
+
* Check user permission
|
|
97
|
+
* @param {String} email Email of the invited user.
|
|
98
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetUserPermission} and HTTP response
|
|
99
|
+
*/
|
|
100
|
+
this.getUserPermissionWithHttpInfo = function(email) {
|
|
101
|
+
var postBody = null;
|
|
102
|
+
|
|
103
|
+
// verify the required parameter 'email' is set
|
|
104
|
+
if (email === undefined || email === null) {
|
|
105
|
+
throw new Error("Missing the required parameter 'email' when calling getUserPermission");
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
var pathParams = {
|
|
110
|
+
'email': email
|
|
111
|
+
};
|
|
112
|
+
var queryParams = {
|
|
113
|
+
};
|
|
114
|
+
var collectionQueryParams = {
|
|
115
|
+
};
|
|
116
|
+
var headerParams = {
|
|
117
|
+
};
|
|
118
|
+
var formParams = {
|
|
119
|
+
};
|
|
120
|
+
|
|
121
|
+
var authNames = ['api-key', 'partner-key'];
|
|
122
|
+
var contentTypes = ['application/json'];
|
|
123
|
+
var accepts = ['application/json'];
|
|
124
|
+
var returnType = GetUserPermission;
|
|
125
|
+
|
|
126
|
+
return this.apiClient.callApi(
|
|
127
|
+
'/organization/user/{email}/permissions', 'GET',
|
|
128
|
+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
|
|
129
|
+
authNames, contentTypes, accepts, returnType
|
|
130
|
+
);
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
/**
|
|
134
|
+
* Check user permission
|
|
135
|
+
* @param {String} email Email of the invited user.
|
|
136
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetUserPermission}
|
|
137
|
+
*/
|
|
138
|
+
this.getUserPermission = function(email) {
|
|
139
|
+
return this.getUserPermissionWithHttpInfo(email)
|
|
140
|
+
.then(function(response_and_data) {
|
|
141
|
+
return response_and_data.data;
|
|
142
|
+
});
|
|
143
|
+
}
|
|
144
|
+
};
|
|
145
|
+
|
|
146
|
+
return exports;
|
|
147
|
+
}));
|