hostinger-api-sdk 1.31.0 → 1.33.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/README.md +2 -2
- package/api.ts +1440 -52
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +1045 -15
- package/dist/api.js +710 -9
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +2 -2
- package/dist/esm/api.d.ts +1045 -15
- package/dist/esm/api.js +693 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +2 -2
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/ReachCampaignsApi.md +190 -0
- package/docs/ReachFormsApi.md +182 -0
- package/docs/ReachListCampaignsV1200Response.md +22 -0
- package/docs/ReachListFormsV1200Response.md +22 -0
- package/docs/ReachProfilesApi.md +54 -0
- package/docs/ReachV1CampaignsCampaignDeliveryResource.md +25 -0
- package/docs/ReachV1CampaignsCampaignDetailsResource.md +52 -0
- package/docs/ReachV1CampaignsCampaignResource.md +44 -0
- package/docs/ReachV1CampaignsCampaignStatisticsResource.md +49 -0
- package/docs/ReachV1CampaignsCampaignSummaryStatisticsResource.md +27 -0
- package/docs/ReachV1FormsFormDetailsResource.md +34 -0
- package/docs/ReachV1FormsFormResource.md +32 -0
- package/docs/ReachV1FormsFormTagResource.md +25 -0
- package/docs/ReachV1FormsFormTemplateDetailsResource.md +25 -0
- package/docs/ReachV1FormsFormTemplateResource.md +23 -0
- package/docs/ReachV1ProfilesPlanLimitUsageResource.md +25 -0
- package/docs/ReachV1ProfilesPlanLimitsResource.md +29 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
/**
|
|
5
5
|
* Hostinger API
|
|
6
6
|
*
|
|
7
|
-
* API Version: 1.
|
|
7
|
+
* API Version: 1.35.0
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
10
10
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
|
@@ -20,14 +20,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
20
20
|
};
|
|
21
21
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
22
22
|
exports.MailV1SchemaCreateWebhookRequestSchemaStatusEnum = exports.MailV1SchemaCreateWebhookRequestSchemaEventsEnum = exports.MailV1OrdersOrderResourceStatusEnum = exports.MailV1MailboxesMailboxResourceStatusEnum = exports.MailV1LogsMailboxActionsMailboxActionLogResourceEventEnum = exports.MailV1LogsActionActionLogResourceResponseStatusEnum = exports.MailV1ApiTokensApiTokenResourceTypeEnum = exports.MailV1ApiTokensApiTokenCreatedResourceTypeEnum = exports.HostingV1WebsitesWebsiteResourceVhostTypeEnum = exports.HostingV1NodeJsVulnerabilityResourceSeverityEnum = exports.HostingV1NodeJsCreateFromArchiveRequestPackageManagerEnum = exports.HostingV1NodeJsCreateFromArchiveRequestAppTypeEnum = exports.HostingV1NodeJsCreateFromArchiveRequestNodeVersionEnum = exports.HostingV1NodeJsBuildResourceStateEnum = exports.HostingV1NodeJsBuildOptionsResourceSourceTypeEnum = exports.HostingV1NodeJsBuildOptionsResourcePackageManagerEnum = exports.HostingV1NodeJsBuildOptionsResourceAppTypeEnum = exports.HostingV1FilesFilesResourceItemsInnerTypeEnum = exports.HostingV1DomainsParkedDomainResourceTypeEnum = exports.HorizonsV1WebsitesCreateWebsiteRequestMessageInnerTypeEnum = exports.EcommerceV1StoreStoreRequestSalesChannelTypeEnum = exports.EcommerceV1StoreStoreCreationResourceSalesChannelTypeEnum = exports.EcommerceV1SalesChannelStoreRequestTypeEnum = exports.EcommerceV1SalesChannelSalesChannelListResourceSalesChannelsInnerTypeEnum = exports.EcommerceV1SalesChannelSalesChannelCreationResourceSalesChannelTypeEnum = exports.EcommerceV1ProductProductCreationResourceProductTypeEnum = exports.DomainsV1WHOISStoreRequestEntityTypeEnum = exports.DomainsV1WHOISProfileResourceEntityTypeEnum = exports.DomainsV1WHOISChangeUpdateRequestChangeForEnum = exports.DomainsV1PortfolioClaimResourceStatusEnum = exports.DomainsV1MoveMoveResourceStatusEnum = exports.DomainsV1IRTPVerificationResourceStatusEnum = exports.DomainsV1ForwardingUpdateRequestRedirectTypeEnum = exports.DomainsV1ForwardingStoreRequestRedirectTypeEnum = exports.DomainsV1ForwardingForwardingResourceRedirectTypeEnum = exports.DomainsV1DomainDomainResourceStatusEnum = exports.DomainsV1DomainDomainResourceTypeEnum = exports.DomainsV1DomainDomainExtendedResourceStatusEnum = exports.DNSV1ZoneUpdateRequestZoneInnerTypeEnum = exports.DNSV1ZoneRecordResourceTypeEnum = exports.DNSV1ZoneDestroyRequestFiltersInnerTypeEnum = exports.BillingV1SubscriptionSubscriptionResourceStatusEnum = exports.BillingV1SubscriptionCancelRequestCancelOptionEnum = exports.BillingV1SubscriptionCancelRequestReasonCodeEnum = exports.BillingV1OrderOrderResourceStatusEnum = exports.BillingV1CatalogCatalogItemPriceResourcePeriodUnitEnum = exports.AgencyHostingV1WebsitesWebsiteResourceStateEnum = exports.AgencyHostingV1WebsitesWebsiteProcessResourceStatusEnum = exports.AgencyHostingV1SetupsWebsiteSetupStatusResourceStatusEnum = exports.AgencyHostingV1SetupsCreateSetupRequestTypeEnum = void 0;
|
|
23
|
-
exports.
|
|
24
|
-
exports.
|
|
25
|
-
exports.
|
|
26
|
-
exports.
|
|
27
|
-
exports.
|
|
28
|
-
exports.
|
|
29
|
-
exports.
|
|
30
|
-
exports.
|
|
23
|
+
exports.VPSV1FirewallRulesStoreRequestProtocolEnum = exports.VPSV1FirewallFirewallRuleResourceProtocolEnum = exports.VPSV1FirewallFirewallRuleResourceActionEnum = exports.VPSV1DockerManagerProjectResourceStateEnum = exports.VPSV1DockerManagerContainerResourceHealthEnum = exports.VPSV1DockerManagerContainerResourceStateEnum = exports.VPSV1DockerManagerContainerPortResourceProtocolEnum = exports.VPSV1DockerManagerContainerPortResourceTypeEnum = exports.VPSV1ActionActionResourceStateEnum = exports.ReachV1FormsFormTagResourceTypeEnum = exports.ReachV1FormsFormResourceTypeEnum = exports.ReachV1FormsFormResourceStatusEnum = exports.ReachV1FormsFormDetailsResourceTypeEnum = exports.ReachV1FormsFormDetailsResourceStatusEnum = exports.ReachV1ContactsUpdateRequestSubscriptionStatusEnum = exports.ReachV1ContactsTagsTagResourceTypeEnum = exports.ReachV1ContactsSegmentsStoreRequestConditionsInnerAttributeEnum = exports.ReachV1ContactsSegmentsStoreRequestConditionsInnerOperatorEnum = exports.ReachV1ContactsSegmentsStoreRequestLogicEnum = exports.ReachV1ContactsSegmentsSegmentationContactResourceSourceEnum = exports.ReachV1ContactsSegmentsSegmentationContactResourceSubscriptionStatusEnum = exports.ReachV1ContactsSegmentsProfileUpdateRequestLogicEnum = exports.ReachV1ContactsSegmentsProfileStoreRequestConditionsInnerOperatorEnum = exports.ReachV1ContactsSegmentsProfileStoreRequestLogicEnum = exports.ReachV1ContactsProfileContactUpdateResourceSubscriptionStatusEnum = exports.ReachV1ContactsProfileContactResourceSourceEnum = exports.ReachV1ContactsProfileContactResourceSubscriptionStatusEnum = exports.ReachV1ContactsFieldsStoreRequestTypeEnum = exports.ReachV1ContactsFieldsContactFieldValueResourceTypeEnum = exports.ReachV1ContactsFieldsContactFieldResourceTypeEnum = exports.ReachV1ContactsContactResourceSourceEnum = exports.ReachV1ContactsContactResourceSubscriptionStatusEnum = exports.ReachV1ContactsContactDetailsResourceSourceEnum = exports.ReachV1ContactsContactDetailsResourceSubscriptionStatusEnum = exports.ReachV1CampaignsCampaignResourceTypeEnum = exports.ReachV1CampaignsCampaignResourceStatusEnum = exports.ReachV1CampaignsCampaignDetailsResourceTypeEnum = exports.ReachV1CampaignsCampaignDetailsResourceStatusEnum = exports.ReachV1AutomationsStepsAutomationStepResourceValueEnum = exports.ReachV1AutomationsStepsAutomationStepResourceTypeEnum = exports.ReachV1AutomationsAutomationResourceTypeEnum = exports.ReachV1AutomationsAutomationResourceStatusEnum = exports.MailV1WebhooksWebhookSecretResourceStatusEnum = exports.MailV1WebhooksWebhookSecretResourceEventsEnum = exports.MailV1WebhooksWebhookResourceStatusEnum = exports.MailV1WebhooksWebhookResourceEventsEnum = exports.MailV1WebhooksWebhookCreatedResourceStatusEnum = exports.MailV1WebhooksWebhookCreatedResourceEventsEnum = exports.MailV1SchemaUpdateWebhookRequestSchemaStatusEnum = exports.MailV1SchemaUpdateWebhookRequestSchemaEventsEnum = void 0;
|
|
24
|
+
exports.AgencyHostingWordPressApiAxiosParamCreator = exports.AgencyHostingWebsitesApi = exports.AgencyHostingWebsitesApiFactory = exports.AgencyHostingWebsitesApiFp = exports.AgencyHostingWebsitesApiAxiosParamCreator = exports.AgencyHostingWebsiteSetupsApi = exports.AgencyHostingWebsiteSetupsApiFactory = exports.AgencyHostingWebsiteSetupsApiFp = exports.AgencyHostingWebsiteSetupsApiAxiosParamCreator = exports.AgencyHostingOrdersApi = exports.AgencyHostingOrdersApiFactory = exports.AgencyHostingOrdersApiFp = exports.AgencyHostingOrdersApiAxiosParamCreator = exports.AgencyHostingFilesApi = exports.AgencyHostingFilesApiFactory = exports.AgencyHostingFilesApiFp = exports.AgencyHostingFilesApiAxiosParamCreator = exports.AgencyHostingDomainsApi = exports.AgencyHostingDomainsApiFactory = exports.AgencyHostingDomainsApiFp = exports.AgencyHostingDomainsApiAxiosParamCreator = exports.AgencyHostingDatacentersApi = exports.AgencyHostingDatacentersApiFactory = exports.AgencyHostingDatacentersApiFp = exports.AgencyHostingDatacentersApiAxiosParamCreator = exports.AgencyHostingDatabasesApi = exports.AgencyHostingDatabasesApiFactory = exports.AgencyHostingDatabasesApiFp = exports.AgencyHostingDatabasesApiAxiosParamCreator = exports.AgencyHostingCronJobsApi = exports.AgencyHostingCronJobsApiFactory = exports.AgencyHostingCronJobsApiFp = exports.AgencyHostingCronJobsApiAxiosParamCreator = exports.AgencyHostingCacheApi = exports.AgencyHostingCacheApiFactory = exports.AgencyHostingCacheApiFp = exports.AgencyHostingCacheApiAxiosParamCreator = exports.WordPressV1ThemesInstalledThemeResourceStatusEnum = exports.WordPressV1ThemesInstallThemeRequestFontEnum = exports.WordPressV1PluginsUpdateHostingerPluginRequestSlugEnum = exports.WordPressV1PluginsSuggestedPluginGroupResourceWebsiteTypeEnum = exports.WordPressV1PluginsInstalledPluginResourceStatusEnum = exports.WordPressV1MemcachedMemcachedStatusResourceStatusEnum = exports.WordPressV1MaintenanceMaintenanceStatusResourceStatusEnum = exports.WordPressV1InstallationsUpdateResourceTypeEnum = exports.WordPressV1InstallationsInstallWordPressRequestAutoUpdatesEnum = exports.WordPressV1HostingerPluginsUpdateAiOptionStatusRequestOptionEnum = exports.VPSV1VirtualMachineVirtualMachineResourceActionsLockEnum = exports.VPSV1VirtualMachineVirtualMachineResourceStateEnum = exports.VPSV1FirewallRulesStoreRequestSourceEnum = void 0;
|
|
25
|
+
exports.DomainsTransferApiFp = exports.DomainsTransferApiAxiosParamCreator = exports.DomainsPortfolioApi = exports.DomainsPortfolioApiFactory = exports.DomainsPortfolioApiFp = exports.DomainsPortfolioApiAxiosParamCreator = exports.DomainsMoveApi = exports.DomainsMoveApiFactory = exports.DomainsMoveApiFp = exports.DomainsMoveApiAxiosParamCreator = exports.DomainsForwardingApi = exports.DomainsForwardingApiFactory = exports.DomainsForwardingApiFp = exports.DomainsForwardingApiAxiosParamCreator = exports.DomainsAvailabilityApi = exports.DomainsAvailabilityApiFactory = exports.DomainsAvailabilityApiFp = exports.DomainsAvailabilityApiAxiosParamCreator = exports.DomainAccessVerifierVerificationsApi = exports.DomainAccessVerifierVerificationsApiFactory = exports.DomainAccessVerifierVerificationsApiFp = exports.DomainAccessVerifierVerificationsApiAxiosParamCreator = exports.DNSZoneApi = exports.DNSZoneApiFactory = exports.DNSZoneApiFp = exports.DNSZoneApiAxiosParamCreator = exports.DNSSnapshotApi = exports.DNSSnapshotApiFactory = exports.DNSSnapshotApiFp = exports.DNSSnapshotApiAxiosParamCreator = exports.BillingSubscriptionsApi = exports.BillingSubscriptionsApiFactory = exports.BillingSubscriptionsApiFp = exports.BillingSubscriptionsApiAxiosParamCreator = exports.BillingPaymentMethodsApi = exports.BillingPaymentMethodsApiFactory = exports.BillingPaymentMethodsApiFp = exports.BillingPaymentMethodsApiAxiosParamCreator = exports.BillingOrdersApi = exports.BillingOrdersApiFactory = exports.BillingOrdersApiFp = exports.BillingOrdersApiAxiosParamCreator = exports.GetCatalogItemListV1CategoryEnum = exports.BillingCatalogApi = exports.BillingCatalogApiFactory = exports.BillingCatalogApiFp = exports.BillingCatalogApiAxiosParamCreator = exports.AgencyHostingWordPressApi = exports.AgencyHostingWordPressApiFactory = exports.AgencyHostingWordPressApiFp = void 0;
|
|
26
|
+
exports.HostingDatacentersApi = exports.HostingDatacentersApiFactory = exports.HostingDatacentersApiFp = exports.HostingDatacentersApiAxiosParamCreator = exports.HostingDatabasesApi = exports.HostingDatabasesApiFactory = exports.HostingDatabasesApiFp = exports.HostingDatabasesApiAxiosParamCreator = exports.HostingCronJobsApi = exports.HostingCronJobsApiFactory = exports.HostingCronJobsApiFp = exports.HostingCronJobsApiAxiosParamCreator = exports.HostingCacheApi = exports.HostingCacheApiFactory = exports.HostingCacheApiFp = exports.HostingCacheApiAxiosParamCreator = exports.HorizonsWebsitesApi = exports.HorizonsWebsitesApiFactory = exports.HorizonsWebsitesApiFp = exports.HorizonsWebsitesApiAxiosParamCreator = exports.EcommerceStoresApi = exports.EcommerceStoresApiFactory = exports.EcommerceStoresApiFp = exports.EcommerceStoresApiAxiosParamCreator = exports.EcommerceShippingApi = exports.EcommerceShippingApiFactory = exports.EcommerceShippingApiFp = exports.EcommerceShippingApiAxiosParamCreator = exports.EcommerceSalesChannelsApi = exports.EcommerceSalesChannelsApiFactory = exports.EcommerceSalesChannelsApiFp = exports.EcommerceSalesChannelsApiAxiosParamCreator = exports.EcommerceProductsApi = exports.EcommerceProductsApiFactory = exports.EcommerceProductsApiFp = exports.EcommerceProductsApiAxiosParamCreator = exports.EcommercePaymentsApi = exports.EcommercePaymentsApiFactory = exports.EcommercePaymentsApiFp = exports.EcommercePaymentsApiAxiosParamCreator = exports.EcommerceMiscellaneousApi = exports.EcommerceMiscellaneousApiFactory = exports.EcommerceMiscellaneousApiFp = exports.EcommerceMiscellaneousApiAxiosParamCreator = exports.DomainsWHOISApi = exports.DomainsWHOISApiFactory = exports.DomainsWHOISApiFp = exports.DomainsWHOISApiAxiosParamCreator = exports.DomainsTransferApi = exports.DomainsTransferApiFactory = void 0;
|
|
27
|
+
exports.MailLogsApiFp = exports.MailLogsApiAxiosParamCreator = exports.MailForwardersApi = exports.MailForwardersApiFactory = exports.MailForwardersApiFp = exports.MailForwardersApiAxiosParamCreator = exports.MailCatchallsApi = exports.MailCatchallsApiFactory = exports.MailCatchallsApiFp = exports.MailCatchallsApiAxiosParamCreator = exports.MailAutorepliesApi = exports.MailAutorepliesApiFactory = exports.MailAutorepliesApiFp = exports.MailAutorepliesApiAxiosParamCreator = exports.MailAliasesApi = exports.MailAliasesApiFactory = exports.MailAliasesApiFp = exports.MailAliasesApiAxiosParamCreator = exports.MailAPITokensApi = exports.MailAPITokensApiFactory = exports.MailAPITokensApiFp = exports.MailAPITokensApiAxiosParamCreator = exports.HostingWebsitesApi = exports.HostingWebsitesApiFactory = exports.HostingWebsitesApiFp = exports.HostingWebsitesApiAxiosParamCreator = exports.HostingPHPApi = exports.HostingPHPApiFactory = exports.HostingPHPApiFp = exports.HostingPHPApiAxiosParamCreator = exports.ListOrdersV1StatusesEnum = exports.HostingOrdersApi = exports.HostingOrdersApiFactory = exports.HostingOrdersApiFp = exports.HostingOrdersApiAxiosParamCreator = exports.ListNodeJsVulnerabilitiesV1SeveritiesEnum = exports.ListNodeJSBuildsV1StatesEnum = exports.HostingNodeJSApi = exports.HostingNodeJSApiFactory = exports.HostingNodeJSApiFp = exports.HostingNodeJSApiAxiosParamCreator = exports.ListWebsiteFilesAndDirectoriesV1FileTypesEnum = exports.HostingFilesApi = exports.HostingFilesApiFactory = exports.HostingFilesApiFp = exports.HostingFilesApiAxiosParamCreator = exports.HostingDomainsApi = exports.HostingDomainsApiFactory = exports.HostingDomainsApiFp = exports.HostingDomainsApiAxiosParamCreator = void 0;
|
|
28
|
+
exports.ReachFormsApiFactory = exports.ReachFormsApiFp = exports.ReachFormsApiAxiosParamCreator = exports.ListProfileContactsV1SubscriptionStatusEnum = exports.ListContactsV1SubscriptionStatusEnum = exports.ReachContactsApi = exports.ReachContactsApiFactory = exports.ReachContactsApiFp = exports.ReachContactsApiAxiosParamCreator = exports.ReachContactFieldsApi = exports.ReachContactFieldsApiFactory = exports.ReachContactFieldsApiFp = exports.ReachContactFieldsApiAxiosParamCreator = exports.ListCampaignsV1SortDirectionEnum = exports.ListCampaignsV1TypeEnum = exports.ListCampaignsV1StatusEnum = exports.ReachCampaignsApi = exports.ReachCampaignsApiFactory = exports.ReachCampaignsApiFp = exports.ReachCampaignsApiAxiosParamCreator = exports.ListAutomationsV1SortDirectionEnum = exports.ListAutomationsV1StatusEnum = exports.ReachAutomationsApi = exports.ReachAutomationsApiFactory = exports.ReachAutomationsApiFp = exports.ReachAutomationsApiAxiosParamCreator = exports.ListWebhooksV1StatusEnum = exports.MailWebhooksApi = exports.MailWebhooksApiFactory = exports.MailWebhooksApiFp = exports.MailWebhooksApiAxiosParamCreator = exports.ListOrdersV1SortEnum = exports.ListOrdersV1StatusEnum = exports.MailOrdersApi = exports.MailOrdersApiFactory = exports.MailOrdersApiFp = exports.MailOrdersApiAxiosParamCreator = exports.ListMailboxesV1SortEnum = exports.MailMailboxesApi = exports.MailMailboxesApiFactory = exports.MailMailboxesApiFp = exports.MailMailboxesApiAxiosParamCreator = exports.ListOutboundLogsV1StatusEnum = exports.ListMailboxActionLogsV1EventEnum = exports.ListInboundLogsV1StatusEnum = exports.ListActionLogsV1StatusEnum = exports.ListAccessLogsV1ProtocolEnum = exports.ListAccessLogsV1StatusEnum = exports.MailLogsApi = exports.MailLogsApiFactory = void 0;
|
|
29
|
+
exports.VPSPostInstallScriptsApi = exports.VPSPostInstallScriptsApiFactory = exports.VPSPostInstallScriptsApiFp = exports.VPSPostInstallScriptsApiAxiosParamCreator = exports.VPSPTRRecordsApi = exports.VPSPTRRecordsApiFactory = exports.VPSPTRRecordsApiFp = exports.VPSPTRRecordsApiAxiosParamCreator = exports.VPSOSTemplatesApi = exports.VPSOSTemplatesApiFactory = exports.VPSOSTemplatesApiFp = exports.VPSOSTemplatesApiAxiosParamCreator = exports.VPSMalwareScannerApi = exports.VPSMalwareScannerApiFactory = exports.VPSMalwareScannerApiFp = exports.VPSMalwareScannerApiAxiosParamCreator = exports.VPSFirewallApi = exports.VPSFirewallApiFactory = exports.VPSFirewallApiFp = exports.VPSFirewallApiAxiosParamCreator = exports.VPSDockerManagerApi = exports.VPSDockerManagerApiFactory = exports.VPSDockerManagerApiFp = exports.VPSDockerManagerApiAxiosParamCreator = exports.VPSDataCentersApi = exports.VPSDataCentersApiFactory = exports.VPSDataCentersApiFp = exports.VPSDataCentersApiAxiosParamCreator = exports.VPSBackupsApi = exports.VPSBackupsApiFactory = exports.VPSBackupsApiFp = exports.VPSBackupsApiAxiosParamCreator = exports.VPSActionsApi = exports.VPSActionsApiFactory = exports.VPSActionsApiFp = exports.VPSActionsApiAxiosParamCreator = exports.ReachTagsApi = exports.ReachTagsApiFactory = exports.ReachTagsApiFp = exports.ReachTagsApiAxiosParamCreator = exports.ListProfileSegmentsV1CountTypeEnum = exports.ReachSegmentsApi = exports.ReachSegmentsApiFactory = exports.ReachSegmentsApiFp = exports.ReachSegmentsApiAxiosParamCreator = exports.ReachProfilesApi = exports.ReachProfilesApiFactory = exports.ReachProfilesApiFp = exports.ReachProfilesApiAxiosParamCreator = exports.ReachFormsApi = void 0;
|
|
30
|
+
exports.WordPressThemesApiFactory = exports.WordPressThemesApiFp = exports.WordPressThemesApiAxiosParamCreator = exports.ListInstalledWordPressPluginsV1CategoryEnum = exports.WordPressPluginsApi = exports.WordPressPluginsApiFactory = exports.WordPressPluginsApiFp = exports.WordPressPluginsApiAxiosParamCreator = exports.WordPressObjectCacheApi = exports.WordPressObjectCacheApiFactory = exports.WordPressObjectCacheApiFp = exports.WordPressObjectCacheApiAxiosParamCreator = exports.WordPressMaintenanceApi = exports.WordPressMaintenanceApiFactory = exports.WordPressMaintenanceApiFp = exports.WordPressMaintenanceApiAxiosParamCreator = exports.WordPressLoginApi = exports.WordPressLoginApiFactory = exports.WordPressLoginApiFp = exports.WordPressLoginApiAxiosParamCreator = exports.WordPressLiteSpeedCacheApi = exports.WordPressLiteSpeedCacheApiFactory = exports.WordPressLiteSpeedCacheApiFp = exports.WordPressLiteSpeedCacheApiAxiosParamCreator = exports.ListWordPressInstallationsV1OwnershipEnum = exports.WordPressInstallationsApi = exports.WordPressInstallationsApiFactory = exports.WordPressInstallationsApiFp = exports.WordPressInstallationsApiAxiosParamCreator = exports.ShowAIOptionStatusV1OptionEnum = exports.WordPressAIToolsApi = exports.WordPressAIToolsApiFactory = exports.WordPressAIToolsApiFp = exports.WordPressAIToolsApiAxiosParamCreator = exports.VPSVirtualMachineApi = exports.VPSVirtualMachineApiFactory = exports.VPSVirtualMachineApiFp = exports.VPSVirtualMachineApiAxiosParamCreator = exports.VPSSnapshotsApi = exports.VPSSnapshotsApiFactory = exports.VPSSnapshotsApiFp = exports.VPSSnapshotsApiAxiosParamCreator = exports.VPSRecoveryApi = exports.VPSRecoveryApiFactory = exports.VPSRecoveryApiFp = exports.VPSRecoveryApiAxiosParamCreator = exports.VPSPublicKeysApi = exports.VPSPublicKeysApiFactory = exports.VPSPublicKeysApiFp = exports.VPSPublicKeysApiAxiosParamCreator = void 0;
|
|
31
|
+
exports.WordPressThemesApi = void 0;
|
|
31
32
|
const axios_1 = require("axios");
|
|
32
33
|
// Some imports not used depending on template conditions
|
|
33
34
|
// @ts-ignore
|
|
@@ -401,6 +402,30 @@ exports.ReachV1AutomationsStepsAutomationStepResourceValueEnum = {
|
|
|
401
402
|
Decision: 'decision',
|
|
402
403
|
Delay: 'delay'
|
|
403
404
|
};
|
|
405
|
+
exports.ReachV1CampaignsCampaignDetailsResourceStatusEnum = {
|
|
406
|
+
Draft: 'draft',
|
|
407
|
+
Scheduled: 'scheduled',
|
|
408
|
+
Sending: 'sending',
|
|
409
|
+
Publish: 'publish',
|
|
410
|
+
Failed: 'failed'
|
|
411
|
+
};
|
|
412
|
+
exports.ReachV1CampaignsCampaignDetailsResourceTypeEnum = {
|
|
413
|
+
Campaign: 'campaign',
|
|
414
|
+
Automation: 'automation',
|
|
415
|
+
DoubleOptIn: 'double_opt_in'
|
|
416
|
+
};
|
|
417
|
+
exports.ReachV1CampaignsCampaignResourceStatusEnum = {
|
|
418
|
+
Draft: 'draft',
|
|
419
|
+
Scheduled: 'scheduled',
|
|
420
|
+
Sending: 'sending',
|
|
421
|
+
Publish: 'publish',
|
|
422
|
+
Failed: 'failed'
|
|
423
|
+
};
|
|
424
|
+
exports.ReachV1CampaignsCampaignResourceTypeEnum = {
|
|
425
|
+
Campaign: 'campaign',
|
|
426
|
+
Automation: 'automation',
|
|
427
|
+
DoubleOptIn: 'double_opt_in'
|
|
428
|
+
};
|
|
404
429
|
exports.ReachV1ContactsContactDetailsResourceSubscriptionStatusEnum = {
|
|
405
430
|
Subscribed: 'subscribed',
|
|
406
431
|
Unsubscribed: 'unsubscribed',
|
|
@@ -588,6 +613,28 @@ exports.ReachV1ContactsUpdateRequestSubscriptionStatusEnum = {
|
|
|
588
613
|
Confirmed: 'confirmed',
|
|
589
614
|
Pending: 'pending'
|
|
590
615
|
};
|
|
616
|
+
exports.ReachV1FormsFormDetailsResourceStatusEnum = {
|
|
617
|
+
Active: 'active',
|
|
618
|
+
Paused: 'paused',
|
|
619
|
+
Draft: 'draft'
|
|
620
|
+
};
|
|
621
|
+
exports.ReachV1FormsFormDetailsResourceTypeEnum = {
|
|
622
|
+
Form: 'form'
|
|
623
|
+
};
|
|
624
|
+
exports.ReachV1FormsFormResourceStatusEnum = {
|
|
625
|
+
Active: 'active',
|
|
626
|
+
Paused: 'paused',
|
|
627
|
+
Draft: 'draft'
|
|
628
|
+
};
|
|
629
|
+
exports.ReachV1FormsFormResourceTypeEnum = {
|
|
630
|
+
Form: 'form'
|
|
631
|
+
};
|
|
632
|
+
exports.ReachV1FormsFormTagResourceTypeEnum = {
|
|
633
|
+
Form: 'form',
|
|
634
|
+
Custom: 'custom',
|
|
635
|
+
Import: 'import',
|
|
636
|
+
System: 'system'
|
|
637
|
+
};
|
|
591
638
|
exports.VPSV1ActionActionResourceStateEnum = {
|
|
592
639
|
Success: 'success',
|
|
593
640
|
Error: 'error',
|
|
@@ -16641,6 +16688,322 @@ exports.ListAutomationsV1SortDirectionEnum = {
|
|
|
16641
16688
|
Asc: 'asc',
|
|
16642
16689
|
Desc: 'desc'
|
|
16643
16690
|
};
|
|
16691
|
+
/**
|
|
16692
|
+
* ReachCampaignsApi - axios parameter creator
|
|
16693
|
+
* @export
|
|
16694
|
+
*/
|
|
16695
|
+
const ReachCampaignsApiAxiosParamCreator = function (configuration) {
|
|
16696
|
+
return {
|
|
16697
|
+
/**
|
|
16698
|
+
* Get a single campaign with its sender, subject, template reference, targeting and delivery progress. This describes how the campaign was set up and how far it has got. For opens, clicks and unsubscribes use the campaign statistics endpoint.
|
|
16699
|
+
* @summary Get campaign details
|
|
16700
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
16701
|
+
* @param {string} campaignUuid Campaign uuid parameter
|
|
16702
|
+
* @param {*} [options] Override http request option.
|
|
16703
|
+
* @throws {RequiredError}
|
|
16704
|
+
*/
|
|
16705
|
+
getCampaignDetailsV1: (profileUuid_1, campaignUuid_1, ...args_1) => __awaiter(this, [profileUuid_1, campaignUuid_1, ...args_1], void 0, function* (profileUuid, campaignUuid, options = {}) {
|
|
16706
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
16707
|
+
(0, common_1.assertParamExists)('getCampaignDetailsV1', 'profileUuid', profileUuid);
|
|
16708
|
+
// verify required parameter 'campaignUuid' is not null or undefined
|
|
16709
|
+
(0, common_1.assertParamExists)('getCampaignDetailsV1', 'campaignUuid', campaignUuid);
|
|
16710
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}`
|
|
16711
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)))
|
|
16712
|
+
.replace(`{${"campaignUuid"}}`, encodeURIComponent(String(campaignUuid)));
|
|
16713
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16714
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
16715
|
+
let baseOptions;
|
|
16716
|
+
if (configuration) {
|
|
16717
|
+
baseOptions = configuration.baseOptions;
|
|
16718
|
+
}
|
|
16719
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
16720
|
+
const localVarHeaderParameter = {};
|
|
16721
|
+
const localVarQueryParameter = {};
|
|
16722
|
+
// authentication apiToken required
|
|
16723
|
+
// http bearer authentication required
|
|
16724
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
16725
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
16726
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16727
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
16728
|
+
return {
|
|
16729
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
16730
|
+
options: localVarRequestOptions,
|
|
16731
|
+
};
|
|
16732
|
+
}),
|
|
16733
|
+
/**
|
|
16734
|
+
* Get the performance of a campaign: delivery, opens, clicks and unsubscribes, with the matching rates. Every count is unique contacts rather than raw events, so a contact who opens the same email five times is counted once.
|
|
16735
|
+
* @summary Get campaign performance
|
|
16736
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
16737
|
+
* @param {string} campaignUuid Campaign uuid parameter
|
|
16738
|
+
* @param {*} [options] Override http request option.
|
|
16739
|
+
* @throws {RequiredError}
|
|
16740
|
+
*/
|
|
16741
|
+
getCampaignPerformanceV1: (profileUuid_1, campaignUuid_1, ...args_1) => __awaiter(this, [profileUuid_1, campaignUuid_1, ...args_1], void 0, function* (profileUuid, campaignUuid, options = {}) {
|
|
16742
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
16743
|
+
(0, common_1.assertParamExists)('getCampaignPerformanceV1', 'profileUuid', profileUuid);
|
|
16744
|
+
// verify required parameter 'campaignUuid' is not null or undefined
|
|
16745
|
+
(0, common_1.assertParamExists)('getCampaignPerformanceV1', 'campaignUuid', campaignUuid);
|
|
16746
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}/statistics`
|
|
16747
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)))
|
|
16748
|
+
.replace(`{${"campaignUuid"}}`, encodeURIComponent(String(campaignUuid)));
|
|
16749
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16750
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
16751
|
+
let baseOptions;
|
|
16752
|
+
if (configuration) {
|
|
16753
|
+
baseOptions = configuration.baseOptions;
|
|
16754
|
+
}
|
|
16755
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
16756
|
+
const localVarHeaderParameter = {};
|
|
16757
|
+
const localVarQueryParameter = {};
|
|
16758
|
+
// authentication apiToken required
|
|
16759
|
+
// http bearer authentication required
|
|
16760
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
16761
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
16762
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16763
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
16764
|
+
return {
|
|
16765
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
16766
|
+
options: localVarRequestOptions,
|
|
16767
|
+
};
|
|
16768
|
+
}),
|
|
16769
|
+
/**
|
|
16770
|
+
* Get a paginated list of the campaigns in a profile. Each campaign carries its headline engagement rates. Filter by status to find drafts, scheduled, sending or sent campaigns, keeping in mind that a fully sent campaign has the status `publish`. By default only regular campaigns are returned - pass `type` to get the emails sent by automations or the double opt-in confirmations instead.
|
|
16771
|
+
* @summary List campaigns
|
|
16772
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
16773
|
+
* @param {ListCampaignsV1StatusEnum} [status] Filter campaigns by status. A fully sent campaign has the status `publish`. There is no `sent` status, and campaigns can be neither paused nor archived.
|
|
16774
|
+
* @param {ListCampaignsV1TypeEnum} [type] Filter campaigns by type. Defaults to `campaign`, which leaves out the emails sent by automations and the double opt-in confirmations.
|
|
16775
|
+
* @param {ListCampaignsV1SortDirectionEnum} [sortDirection] Order campaigns by creation date. Newest first unless set to `asc`.
|
|
16776
|
+
* @param {number} [page] Page number
|
|
16777
|
+
* @param {number} [perPage] Number of items per page
|
|
16778
|
+
* @param {*} [options] Override http request option.
|
|
16779
|
+
* @throws {RequiredError}
|
|
16780
|
+
*/
|
|
16781
|
+
listCampaignsV1: (profileUuid_1, status_1, type_1, sortDirection_1, page_1, perPage_1, ...args_1) => __awaiter(this, [profileUuid_1, status_1, type_1, sortDirection_1, page_1, perPage_1, ...args_1], void 0, function* (profileUuid, status, type, sortDirection, page, perPage, options = {}) {
|
|
16782
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
16783
|
+
(0, common_1.assertParamExists)('listCampaignsV1', 'profileUuid', profileUuid);
|
|
16784
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/campaigns`
|
|
16785
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
|
|
16786
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16787
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
16788
|
+
let baseOptions;
|
|
16789
|
+
if (configuration) {
|
|
16790
|
+
baseOptions = configuration.baseOptions;
|
|
16791
|
+
}
|
|
16792
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
16793
|
+
const localVarHeaderParameter = {};
|
|
16794
|
+
const localVarQueryParameter = {};
|
|
16795
|
+
// authentication apiToken required
|
|
16796
|
+
// http bearer authentication required
|
|
16797
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
16798
|
+
if (status !== undefined) {
|
|
16799
|
+
localVarQueryParameter['status'] = status;
|
|
16800
|
+
}
|
|
16801
|
+
if (type !== undefined) {
|
|
16802
|
+
localVarQueryParameter['type'] = type;
|
|
16803
|
+
}
|
|
16804
|
+
if (sortDirection !== undefined) {
|
|
16805
|
+
localVarQueryParameter['sort_direction'] = sortDirection;
|
|
16806
|
+
}
|
|
16807
|
+
if (page !== undefined) {
|
|
16808
|
+
localVarQueryParameter['page'] = page;
|
|
16809
|
+
}
|
|
16810
|
+
if (perPage !== undefined) {
|
|
16811
|
+
localVarQueryParameter['per_page'] = perPage;
|
|
16812
|
+
}
|
|
16813
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
16814
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16815
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
16816
|
+
return {
|
|
16817
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
16818
|
+
options: localVarRequestOptions,
|
|
16819
|
+
};
|
|
16820
|
+
}),
|
|
16821
|
+
};
|
|
16822
|
+
};
|
|
16823
|
+
exports.ReachCampaignsApiAxiosParamCreator = ReachCampaignsApiAxiosParamCreator;
|
|
16824
|
+
/**
|
|
16825
|
+
* ReachCampaignsApi - functional programming interface
|
|
16826
|
+
* @export
|
|
16827
|
+
*/
|
|
16828
|
+
const ReachCampaignsApiFp = function (configuration) {
|
|
16829
|
+
const localVarAxiosParamCreator = (0, exports.ReachCampaignsApiAxiosParamCreator)(configuration);
|
|
16830
|
+
return {
|
|
16831
|
+
/**
|
|
16832
|
+
* Get a single campaign with its sender, subject, template reference, targeting and delivery progress. This describes how the campaign was set up and how far it has got. For opens, clicks and unsubscribes use the campaign statistics endpoint.
|
|
16833
|
+
* @summary Get campaign details
|
|
16834
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
16835
|
+
* @param {string} campaignUuid Campaign uuid parameter
|
|
16836
|
+
* @param {*} [options] Override http request option.
|
|
16837
|
+
* @throws {RequiredError}
|
|
16838
|
+
*/
|
|
16839
|
+
getCampaignDetailsV1(profileUuid, campaignUuid, options) {
|
|
16840
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
16841
|
+
var _a, _b;
|
|
16842
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getCampaignDetailsV1(profileUuid, campaignUuid, options);
|
|
16843
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['ReachCampaignsApi.getCampaignDetailsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
16844
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
16845
|
+
});
|
|
16846
|
+
},
|
|
16847
|
+
/**
|
|
16848
|
+
* Get the performance of a campaign: delivery, opens, clicks and unsubscribes, with the matching rates. Every count is unique contacts rather than raw events, so a contact who opens the same email five times is counted once.
|
|
16849
|
+
* @summary Get campaign performance
|
|
16850
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
16851
|
+
* @param {string} campaignUuid Campaign uuid parameter
|
|
16852
|
+
* @param {*} [options] Override http request option.
|
|
16853
|
+
* @throws {RequiredError}
|
|
16854
|
+
*/
|
|
16855
|
+
getCampaignPerformanceV1(profileUuid, campaignUuid, options) {
|
|
16856
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
16857
|
+
var _a, _b;
|
|
16858
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getCampaignPerformanceV1(profileUuid, campaignUuid, options);
|
|
16859
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['ReachCampaignsApi.getCampaignPerformanceV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
16860
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
16861
|
+
});
|
|
16862
|
+
},
|
|
16863
|
+
/**
|
|
16864
|
+
* Get a paginated list of the campaigns in a profile. Each campaign carries its headline engagement rates. Filter by status to find drafts, scheduled, sending or sent campaigns, keeping in mind that a fully sent campaign has the status `publish`. By default only regular campaigns are returned - pass `type` to get the emails sent by automations or the double opt-in confirmations instead.
|
|
16865
|
+
* @summary List campaigns
|
|
16866
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
16867
|
+
* @param {ListCampaignsV1StatusEnum} [status] Filter campaigns by status. A fully sent campaign has the status `publish`. There is no `sent` status, and campaigns can be neither paused nor archived.
|
|
16868
|
+
* @param {ListCampaignsV1TypeEnum} [type] Filter campaigns by type. Defaults to `campaign`, which leaves out the emails sent by automations and the double opt-in confirmations.
|
|
16869
|
+
* @param {ListCampaignsV1SortDirectionEnum} [sortDirection] Order campaigns by creation date. Newest first unless set to `asc`.
|
|
16870
|
+
* @param {number} [page] Page number
|
|
16871
|
+
* @param {number} [perPage] Number of items per page
|
|
16872
|
+
* @param {*} [options] Override http request option.
|
|
16873
|
+
* @throws {RequiredError}
|
|
16874
|
+
*/
|
|
16875
|
+
listCampaignsV1(profileUuid, status, type, sortDirection, page, perPage, options) {
|
|
16876
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
16877
|
+
var _a, _b;
|
|
16878
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listCampaignsV1(profileUuid, status, type, sortDirection, page, perPage, options);
|
|
16879
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['ReachCampaignsApi.listCampaignsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
16880
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
16881
|
+
});
|
|
16882
|
+
},
|
|
16883
|
+
};
|
|
16884
|
+
};
|
|
16885
|
+
exports.ReachCampaignsApiFp = ReachCampaignsApiFp;
|
|
16886
|
+
/**
|
|
16887
|
+
* ReachCampaignsApi - factory interface
|
|
16888
|
+
* @export
|
|
16889
|
+
*/
|
|
16890
|
+
const ReachCampaignsApiFactory = function (configuration, basePath, axios) {
|
|
16891
|
+
const localVarFp = (0, exports.ReachCampaignsApiFp)(configuration);
|
|
16892
|
+
return {
|
|
16893
|
+
/**
|
|
16894
|
+
* Get a single campaign with its sender, subject, template reference, targeting and delivery progress. This describes how the campaign was set up and how far it has got. For opens, clicks and unsubscribes use the campaign statistics endpoint.
|
|
16895
|
+
* @summary Get campaign details
|
|
16896
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
16897
|
+
* @param {string} campaignUuid Campaign uuid parameter
|
|
16898
|
+
* @param {*} [options] Override http request option.
|
|
16899
|
+
* @throws {RequiredError}
|
|
16900
|
+
*/
|
|
16901
|
+
getCampaignDetailsV1(profileUuid, campaignUuid, options) {
|
|
16902
|
+
return localVarFp.getCampaignDetailsV1(profileUuid, campaignUuid, options).then((request) => request(axios, basePath));
|
|
16903
|
+
},
|
|
16904
|
+
/**
|
|
16905
|
+
* Get the performance of a campaign: delivery, opens, clicks and unsubscribes, with the matching rates. Every count is unique contacts rather than raw events, so a contact who opens the same email five times is counted once.
|
|
16906
|
+
* @summary Get campaign performance
|
|
16907
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
16908
|
+
* @param {string} campaignUuid Campaign uuid parameter
|
|
16909
|
+
* @param {*} [options] Override http request option.
|
|
16910
|
+
* @throws {RequiredError}
|
|
16911
|
+
*/
|
|
16912
|
+
getCampaignPerformanceV1(profileUuid, campaignUuid, options) {
|
|
16913
|
+
return localVarFp.getCampaignPerformanceV1(profileUuid, campaignUuid, options).then((request) => request(axios, basePath));
|
|
16914
|
+
},
|
|
16915
|
+
/**
|
|
16916
|
+
* Get a paginated list of the campaigns in a profile. Each campaign carries its headline engagement rates. Filter by status to find drafts, scheduled, sending or sent campaigns, keeping in mind that a fully sent campaign has the status `publish`. By default only regular campaigns are returned - pass `type` to get the emails sent by automations or the double opt-in confirmations instead.
|
|
16917
|
+
* @summary List campaigns
|
|
16918
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
16919
|
+
* @param {ListCampaignsV1StatusEnum} [status] Filter campaigns by status. A fully sent campaign has the status `publish`. There is no `sent` status, and campaigns can be neither paused nor archived.
|
|
16920
|
+
* @param {ListCampaignsV1TypeEnum} [type] Filter campaigns by type. Defaults to `campaign`, which leaves out the emails sent by automations and the double opt-in confirmations.
|
|
16921
|
+
* @param {ListCampaignsV1SortDirectionEnum} [sortDirection] Order campaigns by creation date. Newest first unless set to `asc`.
|
|
16922
|
+
* @param {number} [page] Page number
|
|
16923
|
+
* @param {number} [perPage] Number of items per page
|
|
16924
|
+
* @param {*} [options] Override http request option.
|
|
16925
|
+
* @throws {RequiredError}
|
|
16926
|
+
*/
|
|
16927
|
+
listCampaignsV1(profileUuid, status, type, sortDirection, page, perPage, options) {
|
|
16928
|
+
return localVarFp.listCampaignsV1(profileUuid, status, type, sortDirection, page, perPage, options).then((request) => request(axios, basePath));
|
|
16929
|
+
},
|
|
16930
|
+
};
|
|
16931
|
+
};
|
|
16932
|
+
exports.ReachCampaignsApiFactory = ReachCampaignsApiFactory;
|
|
16933
|
+
/**
|
|
16934
|
+
* ReachCampaignsApi - object-oriented interface
|
|
16935
|
+
* @export
|
|
16936
|
+
* @class ReachCampaignsApi
|
|
16937
|
+
* @extends {BaseAPI}
|
|
16938
|
+
*/
|
|
16939
|
+
class ReachCampaignsApi extends base_1.BaseAPI {
|
|
16940
|
+
/**
|
|
16941
|
+
* Get a single campaign with its sender, subject, template reference, targeting and delivery progress. This describes how the campaign was set up and how far it has got. For opens, clicks and unsubscribes use the campaign statistics endpoint.
|
|
16942
|
+
* @summary Get campaign details
|
|
16943
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
16944
|
+
* @param {string} campaignUuid Campaign uuid parameter
|
|
16945
|
+
* @param {*} [options] Override http request option.
|
|
16946
|
+
* @throws {RequiredError}
|
|
16947
|
+
* @memberof ReachCampaignsApi
|
|
16948
|
+
*/
|
|
16949
|
+
getCampaignDetailsV1(profileUuid, campaignUuid, options) {
|
|
16950
|
+
return (0, exports.ReachCampaignsApiFp)(this.configuration).getCampaignDetailsV1(profileUuid, campaignUuid, options).then((request) => request(this.axios, this.basePath));
|
|
16951
|
+
}
|
|
16952
|
+
/**
|
|
16953
|
+
* Get the performance of a campaign: delivery, opens, clicks and unsubscribes, with the matching rates. Every count is unique contacts rather than raw events, so a contact who opens the same email five times is counted once.
|
|
16954
|
+
* @summary Get campaign performance
|
|
16955
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
16956
|
+
* @param {string} campaignUuid Campaign uuid parameter
|
|
16957
|
+
* @param {*} [options] Override http request option.
|
|
16958
|
+
* @throws {RequiredError}
|
|
16959
|
+
* @memberof ReachCampaignsApi
|
|
16960
|
+
*/
|
|
16961
|
+
getCampaignPerformanceV1(profileUuid, campaignUuid, options) {
|
|
16962
|
+
return (0, exports.ReachCampaignsApiFp)(this.configuration).getCampaignPerformanceV1(profileUuid, campaignUuid, options).then((request) => request(this.axios, this.basePath));
|
|
16963
|
+
}
|
|
16964
|
+
/**
|
|
16965
|
+
* Get a paginated list of the campaigns in a profile. Each campaign carries its headline engagement rates. Filter by status to find drafts, scheduled, sending or sent campaigns, keeping in mind that a fully sent campaign has the status `publish`. By default only regular campaigns are returned - pass `type` to get the emails sent by automations or the double opt-in confirmations instead.
|
|
16966
|
+
* @summary List campaigns
|
|
16967
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
16968
|
+
* @param {ListCampaignsV1StatusEnum} [status] Filter campaigns by status. A fully sent campaign has the status `publish`. There is no `sent` status, and campaigns can be neither paused nor archived.
|
|
16969
|
+
* @param {ListCampaignsV1TypeEnum} [type] Filter campaigns by type. Defaults to `campaign`, which leaves out the emails sent by automations and the double opt-in confirmations.
|
|
16970
|
+
* @param {ListCampaignsV1SortDirectionEnum} [sortDirection] Order campaigns by creation date. Newest first unless set to `asc`.
|
|
16971
|
+
* @param {number} [page] Page number
|
|
16972
|
+
* @param {number} [perPage] Number of items per page
|
|
16973
|
+
* @param {*} [options] Override http request option.
|
|
16974
|
+
* @throws {RequiredError}
|
|
16975
|
+
* @memberof ReachCampaignsApi
|
|
16976
|
+
*/
|
|
16977
|
+
listCampaignsV1(profileUuid, status, type, sortDirection, page, perPage, options) {
|
|
16978
|
+
return (0, exports.ReachCampaignsApiFp)(this.configuration).listCampaignsV1(profileUuid, status, type, sortDirection, page, perPage, options).then((request) => request(this.axios, this.basePath));
|
|
16979
|
+
}
|
|
16980
|
+
}
|
|
16981
|
+
exports.ReachCampaignsApi = ReachCampaignsApi;
|
|
16982
|
+
/**
|
|
16983
|
+
* @export
|
|
16984
|
+
*/
|
|
16985
|
+
exports.ListCampaignsV1StatusEnum = {
|
|
16986
|
+
Draft: 'draft',
|
|
16987
|
+
Scheduled: 'scheduled',
|
|
16988
|
+
Sending: 'sending',
|
|
16989
|
+
Publish: 'publish',
|
|
16990
|
+
Failed: 'failed'
|
|
16991
|
+
};
|
|
16992
|
+
/**
|
|
16993
|
+
* @export
|
|
16994
|
+
*/
|
|
16995
|
+
exports.ListCampaignsV1TypeEnum = {
|
|
16996
|
+
Campaign: 'campaign',
|
|
16997
|
+
Automation: 'automation',
|
|
16998
|
+
DoubleOptIn: 'double_opt_in'
|
|
16999
|
+
};
|
|
17000
|
+
/**
|
|
17001
|
+
* @export
|
|
17002
|
+
*/
|
|
17003
|
+
exports.ListCampaignsV1SortDirectionEnum = {
|
|
17004
|
+
Asc: 'asc',
|
|
17005
|
+
Desc: 'desc'
|
|
17006
|
+
};
|
|
16644
17007
|
/**
|
|
16645
17008
|
* ReachContactFieldsApi - axios parameter creator
|
|
16646
17009
|
* @export
|
|
@@ -17821,6 +18184,276 @@ exports.ListProfileContactsV1SubscriptionStatusEnum = {
|
|
|
17821
18184
|
Confirmed: 'confirmed',
|
|
17822
18185
|
Pending: 'pending'
|
|
17823
18186
|
};
|
|
18187
|
+
/**
|
|
18188
|
+
* ReachFormsApi - axios parameter creator
|
|
18189
|
+
* @export
|
|
18190
|
+
*/
|
|
18191
|
+
const ReachFormsApiAxiosParamCreator = function (configuration) {
|
|
18192
|
+
return {
|
|
18193
|
+
/**
|
|
18194
|
+
* Permanently delete a form together with its template. A form that has already captured submissions cannot be deleted, so that the contacts it collected are never silently discarded - pause the form instead to stop it collecting new ones. Views alone do not block deletion.
|
|
18195
|
+
* @summary Delete form
|
|
18196
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18197
|
+
* @param {string} formUuid Form uuid parameter
|
|
18198
|
+
* @param {*} [options] Override http request option.
|
|
18199
|
+
* @throws {RequiredError}
|
|
18200
|
+
*/
|
|
18201
|
+
deleteFormV1: (profileUuid_1, formUuid_1, ...args_1) => __awaiter(this, [profileUuid_1, formUuid_1, ...args_1], void 0, function* (profileUuid, formUuid, options = {}) {
|
|
18202
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
18203
|
+
(0, common_1.assertParamExists)('deleteFormV1', 'profileUuid', profileUuid);
|
|
18204
|
+
// verify required parameter 'formUuid' is not null or undefined
|
|
18205
|
+
(0, common_1.assertParamExists)('deleteFormV1', 'formUuid', formUuid);
|
|
18206
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}`
|
|
18207
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)))
|
|
18208
|
+
.replace(`{${"formUuid"}}`, encodeURIComponent(String(formUuid)));
|
|
18209
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
18210
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
18211
|
+
let baseOptions;
|
|
18212
|
+
if (configuration) {
|
|
18213
|
+
baseOptions = configuration.baseOptions;
|
|
18214
|
+
}
|
|
18215
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
18216
|
+
const localVarHeaderParameter = {};
|
|
18217
|
+
const localVarQueryParameter = {};
|
|
18218
|
+
// authentication apiToken required
|
|
18219
|
+
// http bearer authentication required
|
|
18220
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
18221
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
18222
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
18223
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
18224
|
+
return {
|
|
18225
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
18226
|
+
options: localVarRequestOptions,
|
|
18227
|
+
};
|
|
18228
|
+
}),
|
|
18229
|
+
/**
|
|
18230
|
+
* Get a single form with the URL of its hosted template and the tags it applies to the contacts it captures. There is no ready-made embed snippet in the response - either serve the template HTML yourself or build your own embed around the form uuid.
|
|
18231
|
+
* @summary Get form details
|
|
18232
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18233
|
+
* @param {string} formUuid Form uuid parameter
|
|
18234
|
+
* @param {*} [options] Override http request option.
|
|
18235
|
+
* @throws {RequiredError}
|
|
18236
|
+
*/
|
|
18237
|
+
getFormDetailsV1: (profileUuid_1, formUuid_1, ...args_1) => __awaiter(this, [profileUuid_1, formUuid_1, ...args_1], void 0, function* (profileUuid, formUuid, options = {}) {
|
|
18238
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
18239
|
+
(0, common_1.assertParamExists)('getFormDetailsV1', 'profileUuid', profileUuid);
|
|
18240
|
+
// verify required parameter 'formUuid' is not null or undefined
|
|
18241
|
+
(0, common_1.assertParamExists)('getFormDetailsV1', 'formUuid', formUuid);
|
|
18242
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}`
|
|
18243
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)))
|
|
18244
|
+
.replace(`{${"formUuid"}}`, encodeURIComponent(String(formUuid)));
|
|
18245
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
18246
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
18247
|
+
let baseOptions;
|
|
18248
|
+
if (configuration) {
|
|
18249
|
+
baseOptions = configuration.baseOptions;
|
|
18250
|
+
}
|
|
18251
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
18252
|
+
const localVarHeaderParameter = {};
|
|
18253
|
+
const localVarQueryParameter = {};
|
|
18254
|
+
// authentication apiToken required
|
|
18255
|
+
// http bearer authentication required
|
|
18256
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
18257
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
18258
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
18259
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
18260
|
+
return {
|
|
18261
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
18262
|
+
options: localVarRequestOptions,
|
|
18263
|
+
};
|
|
18264
|
+
}),
|
|
18265
|
+
/**
|
|
18266
|
+
* Get a paginated list of the signup forms in a profile. Each form carries a reference to the template that renders it. Get the form details for a directly usable template URL and for the tags the form puts on the contacts it captures.
|
|
18267
|
+
* @summary List forms
|
|
18268
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18269
|
+
* @param {number} [page] Page number
|
|
18270
|
+
* @param {number} [perPage] Number of items per page
|
|
18271
|
+
* @param {*} [options] Override http request option.
|
|
18272
|
+
* @throws {RequiredError}
|
|
18273
|
+
*/
|
|
18274
|
+
listFormsV1: (profileUuid_1, page_1, perPage_1, ...args_1) => __awaiter(this, [profileUuid_1, page_1, perPage_1, ...args_1], void 0, function* (profileUuid, page, perPage, options = {}) {
|
|
18275
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
18276
|
+
(0, common_1.assertParamExists)('listFormsV1', 'profileUuid', profileUuid);
|
|
18277
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/forms`
|
|
18278
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
|
|
18279
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
18280
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
18281
|
+
let baseOptions;
|
|
18282
|
+
if (configuration) {
|
|
18283
|
+
baseOptions = configuration.baseOptions;
|
|
18284
|
+
}
|
|
18285
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
18286
|
+
const localVarHeaderParameter = {};
|
|
18287
|
+
const localVarQueryParameter = {};
|
|
18288
|
+
// authentication apiToken required
|
|
18289
|
+
// http bearer authentication required
|
|
18290
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
18291
|
+
if (page !== undefined) {
|
|
18292
|
+
localVarQueryParameter['page'] = page;
|
|
18293
|
+
}
|
|
18294
|
+
if (perPage !== undefined) {
|
|
18295
|
+
localVarQueryParameter['per_page'] = perPage;
|
|
18296
|
+
}
|
|
18297
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
18298
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
18299
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
18300
|
+
return {
|
|
18301
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
18302
|
+
options: localVarRequestOptions,
|
|
18303
|
+
};
|
|
18304
|
+
}),
|
|
18305
|
+
};
|
|
18306
|
+
};
|
|
18307
|
+
exports.ReachFormsApiAxiosParamCreator = ReachFormsApiAxiosParamCreator;
|
|
18308
|
+
/**
|
|
18309
|
+
* ReachFormsApi - functional programming interface
|
|
18310
|
+
* @export
|
|
18311
|
+
*/
|
|
18312
|
+
const ReachFormsApiFp = function (configuration) {
|
|
18313
|
+
const localVarAxiosParamCreator = (0, exports.ReachFormsApiAxiosParamCreator)(configuration);
|
|
18314
|
+
return {
|
|
18315
|
+
/**
|
|
18316
|
+
* Permanently delete a form together with its template. A form that has already captured submissions cannot be deleted, so that the contacts it collected are never silently discarded - pause the form instead to stop it collecting new ones. Views alone do not block deletion.
|
|
18317
|
+
* @summary Delete form
|
|
18318
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18319
|
+
* @param {string} formUuid Form uuid parameter
|
|
18320
|
+
* @param {*} [options] Override http request option.
|
|
18321
|
+
* @throws {RequiredError}
|
|
18322
|
+
*/
|
|
18323
|
+
deleteFormV1(profileUuid, formUuid, options) {
|
|
18324
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
18325
|
+
var _a, _b;
|
|
18326
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteFormV1(profileUuid, formUuid, options);
|
|
18327
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['ReachFormsApi.deleteFormV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
18328
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18329
|
+
});
|
|
18330
|
+
},
|
|
18331
|
+
/**
|
|
18332
|
+
* Get a single form with the URL of its hosted template and the tags it applies to the contacts it captures. There is no ready-made embed snippet in the response - either serve the template HTML yourself or build your own embed around the form uuid.
|
|
18333
|
+
* @summary Get form details
|
|
18334
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18335
|
+
* @param {string} formUuid Form uuid parameter
|
|
18336
|
+
* @param {*} [options] Override http request option.
|
|
18337
|
+
* @throws {RequiredError}
|
|
18338
|
+
*/
|
|
18339
|
+
getFormDetailsV1(profileUuid, formUuid, options) {
|
|
18340
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
18341
|
+
var _a, _b;
|
|
18342
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getFormDetailsV1(profileUuid, formUuid, options);
|
|
18343
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['ReachFormsApi.getFormDetailsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
18344
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18345
|
+
});
|
|
18346
|
+
},
|
|
18347
|
+
/**
|
|
18348
|
+
* Get a paginated list of the signup forms in a profile. Each form carries a reference to the template that renders it. Get the form details for a directly usable template URL and for the tags the form puts on the contacts it captures.
|
|
18349
|
+
* @summary List forms
|
|
18350
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18351
|
+
* @param {number} [page] Page number
|
|
18352
|
+
* @param {number} [perPage] Number of items per page
|
|
18353
|
+
* @param {*} [options] Override http request option.
|
|
18354
|
+
* @throws {RequiredError}
|
|
18355
|
+
*/
|
|
18356
|
+
listFormsV1(profileUuid, page, perPage, options) {
|
|
18357
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
18358
|
+
var _a, _b;
|
|
18359
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listFormsV1(profileUuid, page, perPage, options);
|
|
18360
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['ReachFormsApi.listFormsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
18361
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18362
|
+
});
|
|
18363
|
+
},
|
|
18364
|
+
};
|
|
18365
|
+
};
|
|
18366
|
+
exports.ReachFormsApiFp = ReachFormsApiFp;
|
|
18367
|
+
/**
|
|
18368
|
+
* ReachFormsApi - factory interface
|
|
18369
|
+
* @export
|
|
18370
|
+
*/
|
|
18371
|
+
const ReachFormsApiFactory = function (configuration, basePath, axios) {
|
|
18372
|
+
const localVarFp = (0, exports.ReachFormsApiFp)(configuration);
|
|
18373
|
+
return {
|
|
18374
|
+
/**
|
|
18375
|
+
* Permanently delete a form together with its template. A form that has already captured submissions cannot be deleted, so that the contacts it collected are never silently discarded - pause the form instead to stop it collecting new ones. Views alone do not block deletion.
|
|
18376
|
+
* @summary Delete form
|
|
18377
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18378
|
+
* @param {string} formUuid Form uuid parameter
|
|
18379
|
+
* @param {*} [options] Override http request option.
|
|
18380
|
+
* @throws {RequiredError}
|
|
18381
|
+
*/
|
|
18382
|
+
deleteFormV1(profileUuid, formUuid, options) {
|
|
18383
|
+
return localVarFp.deleteFormV1(profileUuid, formUuid, options).then((request) => request(axios, basePath));
|
|
18384
|
+
},
|
|
18385
|
+
/**
|
|
18386
|
+
* Get a single form with the URL of its hosted template and the tags it applies to the contacts it captures. There is no ready-made embed snippet in the response - either serve the template HTML yourself or build your own embed around the form uuid.
|
|
18387
|
+
* @summary Get form details
|
|
18388
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18389
|
+
* @param {string} formUuid Form uuid parameter
|
|
18390
|
+
* @param {*} [options] Override http request option.
|
|
18391
|
+
* @throws {RequiredError}
|
|
18392
|
+
*/
|
|
18393
|
+
getFormDetailsV1(profileUuid, formUuid, options) {
|
|
18394
|
+
return localVarFp.getFormDetailsV1(profileUuid, formUuid, options).then((request) => request(axios, basePath));
|
|
18395
|
+
},
|
|
18396
|
+
/**
|
|
18397
|
+
* Get a paginated list of the signup forms in a profile. Each form carries a reference to the template that renders it. Get the form details for a directly usable template URL and for the tags the form puts on the contacts it captures.
|
|
18398
|
+
* @summary List forms
|
|
18399
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18400
|
+
* @param {number} [page] Page number
|
|
18401
|
+
* @param {number} [perPage] Number of items per page
|
|
18402
|
+
* @param {*} [options] Override http request option.
|
|
18403
|
+
* @throws {RequiredError}
|
|
18404
|
+
*/
|
|
18405
|
+
listFormsV1(profileUuid, page, perPage, options) {
|
|
18406
|
+
return localVarFp.listFormsV1(profileUuid, page, perPage, options).then((request) => request(axios, basePath));
|
|
18407
|
+
},
|
|
18408
|
+
};
|
|
18409
|
+
};
|
|
18410
|
+
exports.ReachFormsApiFactory = ReachFormsApiFactory;
|
|
18411
|
+
/**
|
|
18412
|
+
* ReachFormsApi - object-oriented interface
|
|
18413
|
+
* @export
|
|
18414
|
+
* @class ReachFormsApi
|
|
18415
|
+
* @extends {BaseAPI}
|
|
18416
|
+
*/
|
|
18417
|
+
class ReachFormsApi extends base_1.BaseAPI {
|
|
18418
|
+
/**
|
|
18419
|
+
* Permanently delete a form together with its template. A form that has already captured submissions cannot be deleted, so that the contacts it collected are never silently discarded - pause the form instead to stop it collecting new ones. Views alone do not block deletion.
|
|
18420
|
+
* @summary Delete form
|
|
18421
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18422
|
+
* @param {string} formUuid Form uuid parameter
|
|
18423
|
+
* @param {*} [options] Override http request option.
|
|
18424
|
+
* @throws {RequiredError}
|
|
18425
|
+
* @memberof ReachFormsApi
|
|
18426
|
+
*/
|
|
18427
|
+
deleteFormV1(profileUuid, formUuid, options) {
|
|
18428
|
+
return (0, exports.ReachFormsApiFp)(this.configuration).deleteFormV1(profileUuid, formUuid, options).then((request) => request(this.axios, this.basePath));
|
|
18429
|
+
}
|
|
18430
|
+
/**
|
|
18431
|
+
* Get a single form with the URL of its hosted template and the tags it applies to the contacts it captures. There is no ready-made embed snippet in the response - either serve the template HTML yourself or build your own embed around the form uuid.
|
|
18432
|
+
* @summary Get form details
|
|
18433
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18434
|
+
* @param {string} formUuid Form uuid parameter
|
|
18435
|
+
* @param {*} [options] Override http request option.
|
|
18436
|
+
* @throws {RequiredError}
|
|
18437
|
+
* @memberof ReachFormsApi
|
|
18438
|
+
*/
|
|
18439
|
+
getFormDetailsV1(profileUuid, formUuid, options) {
|
|
18440
|
+
return (0, exports.ReachFormsApiFp)(this.configuration).getFormDetailsV1(profileUuid, formUuid, options).then((request) => request(this.axios, this.basePath));
|
|
18441
|
+
}
|
|
18442
|
+
/**
|
|
18443
|
+
* Get a paginated list of the signup forms in a profile. Each form carries a reference to the template that renders it. Get the form details for a directly usable template URL and for the tags the form puts on the contacts it captures.
|
|
18444
|
+
* @summary List forms
|
|
18445
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18446
|
+
* @param {number} [page] Page number
|
|
18447
|
+
* @param {number} [perPage] Number of items per page
|
|
18448
|
+
* @param {*} [options] Override http request option.
|
|
18449
|
+
* @throws {RequiredError}
|
|
18450
|
+
* @memberof ReachFormsApi
|
|
18451
|
+
*/
|
|
18452
|
+
listFormsV1(profileUuid, page, perPage, options) {
|
|
18453
|
+
return (0, exports.ReachFormsApiFp)(this.configuration).listFormsV1(profileUuid, page, perPage, options).then((request) => request(this.axios, this.basePath));
|
|
18454
|
+
}
|
|
18455
|
+
}
|
|
18456
|
+
exports.ReachFormsApi = ReachFormsApi;
|
|
17824
18457
|
/**
|
|
17825
18458
|
* ReachProfilesApi - axios parameter creator
|
|
17826
18459
|
* @export
|
|
@@ -17859,6 +18492,38 @@ const ReachProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
17859
18492
|
options: localVarRequestOptions,
|
|
17860
18493
|
};
|
|
17861
18494
|
}),
|
|
18495
|
+
/**
|
|
18496
|
+
* Get how much of the plan is left for the current period. Two things to keep in mind before you build alerting on this. The period is a calendar month rather than a billing anniversary, so the counters reset on the 1st no matter when the subscription started. And usage is tracked per order, so every profile on the same order shares one pool and reports the same numbers here. Only the current period is available, past usage is not kept.
|
|
18497
|
+
* @summary Get remaining plan limits
|
|
18498
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18499
|
+
* @param {*} [options] Override http request option.
|
|
18500
|
+
* @throws {RequiredError}
|
|
18501
|
+
*/
|
|
18502
|
+
getRemainingPlanLimitsV1: (profileUuid_1, ...args_1) => __awaiter(this, [profileUuid_1, ...args_1], void 0, function* (profileUuid, options = {}) {
|
|
18503
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
18504
|
+
(0, common_1.assertParamExists)('getRemainingPlanLimitsV1', 'profileUuid', profileUuid);
|
|
18505
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/limits`
|
|
18506
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
|
|
18507
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
18508
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
18509
|
+
let baseOptions;
|
|
18510
|
+
if (configuration) {
|
|
18511
|
+
baseOptions = configuration.baseOptions;
|
|
18512
|
+
}
|
|
18513
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
18514
|
+
const localVarHeaderParameter = {};
|
|
18515
|
+
const localVarQueryParameter = {};
|
|
18516
|
+
// authentication apiToken required
|
|
18517
|
+
// http bearer authentication required
|
|
18518
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
18519
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
18520
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
18521
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
18522
|
+
return {
|
|
18523
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
18524
|
+
options: localVarRequestOptions,
|
|
18525
|
+
};
|
|
18526
|
+
}),
|
|
17862
18527
|
/**
|
|
17863
18528
|
* This endpoint returns all profiles available to the client, including their basic information.
|
|
17864
18529
|
* @summary List Profiles
|
|
@@ -17912,6 +18577,21 @@ const ReachProfilesApiFp = function (configuration) {
|
|
|
17912
18577
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17913
18578
|
});
|
|
17914
18579
|
},
|
|
18580
|
+
/**
|
|
18581
|
+
* Get how much of the plan is left for the current period. Two things to keep in mind before you build alerting on this. The period is a calendar month rather than a billing anniversary, so the counters reset on the 1st no matter when the subscription started. And usage is tracked per order, so every profile on the same order shares one pool and reports the same numbers here. Only the current period is available, past usage is not kept.
|
|
18582
|
+
* @summary Get remaining plan limits
|
|
18583
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18584
|
+
* @param {*} [options] Override http request option.
|
|
18585
|
+
* @throws {RequiredError}
|
|
18586
|
+
*/
|
|
18587
|
+
getRemainingPlanLimitsV1(profileUuid, options) {
|
|
18588
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
18589
|
+
var _a, _b;
|
|
18590
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getRemainingPlanLimitsV1(profileUuid, options);
|
|
18591
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['ReachProfilesApi.getRemainingPlanLimitsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
18592
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18593
|
+
});
|
|
18594
|
+
},
|
|
17915
18595
|
/**
|
|
17916
18596
|
* This endpoint returns all profiles available to the client, including their basic information.
|
|
17917
18597
|
* @summary List Profiles
|
|
@@ -17946,6 +18626,16 @@ const ReachProfilesApiFactory = function (configuration, basePath, axios) {
|
|
|
17946
18626
|
getProfileDomainDNSStatusV1(profileUuid, options) {
|
|
17947
18627
|
return localVarFp.getProfileDomainDNSStatusV1(profileUuid, options).then((request) => request(axios, basePath));
|
|
17948
18628
|
},
|
|
18629
|
+
/**
|
|
18630
|
+
* Get how much of the plan is left for the current period. Two things to keep in mind before you build alerting on this. The period is a calendar month rather than a billing anniversary, so the counters reset on the 1st no matter when the subscription started. And usage is tracked per order, so every profile on the same order shares one pool and reports the same numbers here. Only the current period is available, past usage is not kept.
|
|
18631
|
+
* @summary Get remaining plan limits
|
|
18632
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18633
|
+
* @param {*} [options] Override http request option.
|
|
18634
|
+
* @throws {RequiredError}
|
|
18635
|
+
*/
|
|
18636
|
+
getRemainingPlanLimitsV1(profileUuid, options) {
|
|
18637
|
+
return localVarFp.getRemainingPlanLimitsV1(profileUuid, options).then((request) => request(axios, basePath));
|
|
18638
|
+
},
|
|
17949
18639
|
/**
|
|
17950
18640
|
* This endpoint returns all profiles available to the client, including their basic information.
|
|
17951
18641
|
* @summary List Profiles
|
|
@@ -17976,6 +18666,17 @@ class ReachProfilesApi extends base_1.BaseAPI {
|
|
|
17976
18666
|
getProfileDomainDNSStatusV1(profileUuid, options) {
|
|
17977
18667
|
return (0, exports.ReachProfilesApiFp)(this.configuration).getProfileDomainDNSStatusV1(profileUuid, options).then((request) => request(this.axios, this.basePath));
|
|
17978
18668
|
}
|
|
18669
|
+
/**
|
|
18670
|
+
* Get how much of the plan is left for the current period. Two things to keep in mind before you build alerting on this. The period is a calendar month rather than a billing anniversary, so the counters reset on the 1st no matter when the subscription started. And usage is tracked per order, so every profile on the same order shares one pool and reports the same numbers here. Only the current period is available, past usage is not kept.
|
|
18671
|
+
* @summary Get remaining plan limits
|
|
18672
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18673
|
+
* @param {*} [options] Override http request option.
|
|
18674
|
+
* @throws {RequiredError}
|
|
18675
|
+
* @memberof ReachProfilesApi
|
|
18676
|
+
*/
|
|
18677
|
+
getRemainingPlanLimitsV1(profileUuid, options) {
|
|
18678
|
+
return (0, exports.ReachProfilesApiFp)(this.configuration).getRemainingPlanLimitsV1(profileUuid, options).then((request) => request(this.axios, this.basePath));
|
|
18679
|
+
}
|
|
17979
18680
|
/**
|
|
17980
18681
|
* This endpoint returns all profiles available to the client, including their basic information.
|
|
17981
18682
|
* @summary List Profiles
|