@seekora-ai/admin-api 1.0.46 → 1.0.48
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 +20 -3
- package/api.ts +1247 -105
- package/dist/api.d.ts +1109 -280
- package/dist/api.js +644 -48
- package/dist/esm/api.d.ts +1109 -280
- package/dist/esm/api.js +636 -44
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.0.48.tgz +0 -0
- package/seekora-ai-admin-api-1.0.46.tgz +0 -0
package/dist/api.js
CHANGED
|
@@ -22,10 +22,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.
|
|
26
|
-
exports.
|
|
27
|
-
exports.
|
|
28
|
-
exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiAxiosParamCreator = exports.SubscriptionsApi = exports.SubscriptionsApiFactory = exports.SubscriptionsApiFp = exports.SubscriptionsApiAxiosParamCreator = exports.StoresApi = exports.StoresApiFactory = exports.StoresApiFp = exports.StoresApiAxiosParamCreator = exports.StoreDocumentsApi = exports.StoreDocumentsApiFactory = exports.StoreDocumentsApiFp = exports.StoreDocumentsApiAxiosParamCreator = exports.StopwordsApi = exports.StopwordsApiFactory = exports.StopwordsApiFp = exports.StopwordsApiAxiosParamCreator = exports.SearchApi = exports.SearchApiFactory = exports.SearchApiFp = exports.SearchApiAxiosParamCreator = exports.RolesApi = exports.RolesApiFactory = exports.RolesApiFp = exports.RolesApiAxiosParamCreator = exports.RoleRightsApi = exports.RoleRightsApiFactory = exports.RoleRightsApiFp = exports.RoleRightsApiAxiosParamCreator = exports.RequestsApi = void 0;
|
|
25
|
+
exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDKpiGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDFiltersTrendsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDFiltersTrendsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDFiltersTrendsGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDFiltersGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDFiltersGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDFiltersGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDFiltersEffectivenessGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDFiltersEffectivenessGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDFiltersCombinationsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDFiltersCombinationsGetSortByEnum = exports.AnalyticsApi = exports.AnalyticsApiFactory = exports.AnalyticsApiFp = exports.AnalyticsApiAxiosParamCreator = exports.AccountSettingsApi = exports.AccountSettingsApiFactory = exports.AccountSettingsApiFp = exports.AccountSettingsApiAxiosParamCreator = exports.APICallsApi = exports.APICallsApiFactory = exports.APICallsApiFp = exports.APICallsApiAxiosParamCreator = exports.DataTypesUpdateWordStatusRequestWordTypeEnum = exports.DataTypesUpdatePluralDeclensionRequestTypeEnum = exports.DataTypesCreditTransactionTransactionTypeEnum = exports.DataTypesCreateTaskRequestTypeEnum = exports.DataTypesCreateTaskRequestIndexingStrategyEnum = exports.DataTypesCreateTaskRequestFrequencyEnum = exports.DataTypesCreatePluralDeclensionRequestTypeEnum = exports.DataTypesCreatePaymentOrderRequestPaymentTypeEnum = exports.DataTypesCreateCustomWordListRequestTypeEnum = void 0;
|
|
26
|
+
exports.AdminAnalyticsStoreXStoreIDItemsTrendsGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDItemsPerformanceGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDItemsPerformanceGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDItemsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDItemsDiscoveryGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDItemsDiscoveryGetSortByEnum = exports.ItemAnalyticsApi = exports.ItemAnalyticsApiFactory = exports.ItemAnalyticsApiFp = exports.ItemAnalyticsApiAxiosParamCreator = exports.DocumentsApi = exports.DocumentsApiFactory = exports.DocumentsApiFp = exports.DocumentsApiAxiosParamCreator = exports.CustomStopwordsApi = exports.CustomStopwordsApiFactory = exports.CustomStopwordsApiFp = exports.CustomStopwordsApiAxiosParamCreator = exports.ApiCreditsTransactionsGetTypeEnum = exports.CreditsApi = exports.CreditsApiFactory = exports.CreditsApiFp = exports.CreditsApiAxiosParamCreator = exports.ConnectorsApi = exports.ConnectorsApiFactory = exports.ConnectorsApiFp = exports.ConnectorsApiAxiosParamCreator = exports.AuthApi = exports.AuthApiFactory = exports.AuthApiFp = exports.AuthApiAxiosParamCreator = exports.ArticlesApi = exports.ArticlesApiFactory = exports.ArticlesApiFp = exports.ArticlesApiAxiosParamCreator = exports.AnalyticsEventsApi = exports.AnalyticsEventsApiFactory = exports.AnalyticsEventsApiFp = exports.AnalyticsEventsApiAxiosParamCreator = exports.AdminAnalyticsStoreXStoreIDTagsSummaryGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDTagsSummaryGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDTagsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDTagsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDResultsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum = void 0;
|
|
27
|
+
exports.PluralsDeclensionsApiFp = exports.PluralsDeclensionsApiAxiosParamCreator = exports.PlansApi = exports.PlansApiFactory = exports.PlansApiFp = exports.PlansApiAxiosParamCreator = exports.PaymentsApi = exports.PaymentsApiFactory = exports.PaymentsApiFp = exports.PaymentsApiAxiosParamCreator = exports.PaymentGatewayApi = exports.PaymentGatewayApiFactory = exports.PaymentGatewayApiFp = exports.PaymentGatewayApiAxiosParamCreator = exports.ParentMenusApi = exports.ParentMenusApiFactory = exports.ParentMenusApiFp = exports.ParentMenusApiAxiosParamCreator = exports.OrganizationsApi = exports.OrganizationsApiFactory = exports.OrganizationsApiFp = exports.OrganizationsApiAxiosParamCreator = exports.OnboardingApi = exports.OnboardingApiFactory = exports.OnboardingApiFp = exports.OnboardingApiAxiosParamCreator = exports.NewsLettersApi = exports.NewsLettersApiFactory = exports.NewsLettersApiFp = exports.NewsLettersApiAxiosParamCreator = exports.MongoDbApi = exports.MongoDbApiFactory = exports.MongoDbApiFp = exports.MongoDbApiAxiosParamCreator = exports.ModulesApi = exports.ModulesApiFactory = exports.ModulesApiFp = exports.ModulesApiAxiosParamCreator = exports.MenusApi = exports.MenusApiFactory = exports.MenusApiFp = exports.MenusApiAxiosParamCreator = exports.LimitsApi = exports.LimitsApiFactory = exports.LimitsApiFp = exports.LimitsApiAxiosParamCreator = exports.AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDItemsTrendsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDItemsTrendsGetSortByEnum = void 0;
|
|
28
|
+
exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiAxiosParamCreator = exports.SubscriptionsApi = exports.SubscriptionsApiFactory = exports.SubscriptionsApiFp = exports.SubscriptionsApiAxiosParamCreator = exports.StoresApi = exports.StoresApiFactory = exports.StoresApiFp = exports.StoresApiAxiosParamCreator = exports.StoreDocumentsApi = exports.StoreDocumentsApiFactory = exports.StoreDocumentsApiFp = exports.StoreDocumentsApiAxiosParamCreator = exports.StopwordsApi = exports.StopwordsApiFactory = exports.StopwordsApiFp = exports.StopwordsApiAxiosParamCreator = exports.SearchApi = exports.SearchApiFactory = exports.SearchApiFp = exports.SearchApiAxiosParamCreator = exports.RolesApi = exports.RolesApiFactory = exports.RolesApiFp = exports.RolesApiAxiosParamCreator = exports.RoleRightsApi = exports.RoleRightsApiFactory = exports.RoleRightsApiFp = exports.RoleRightsApiAxiosParamCreator = exports.RequestsApi = exports.RequestsApiFactory = exports.RequestsApiFp = exports.RequestsApiAxiosParamCreator = exports.RegisterApi = exports.RegisterApiFactory = exports.RegisterApiFp = exports.RegisterApiAxiosParamCreator = exports.PluralsDeclensionsApi = exports.PluralsDeclensionsApiFactory = void 0;
|
|
29
29
|
const axios_1 = require("axios");
|
|
30
30
|
// Some imports not used depending on template conditions
|
|
31
31
|
// @ts-ignore
|
|
@@ -36,6 +36,11 @@ exports.DataTypesCreateCustomWordListRequestTypeEnum = {
|
|
|
36
36
|
Stopwords: 'stopwords',
|
|
37
37
|
Synonyms: 'synonyms'
|
|
38
38
|
};
|
|
39
|
+
exports.DataTypesCreatePaymentOrderRequestPaymentTypeEnum = {
|
|
40
|
+
Generic: 'generic',
|
|
41
|
+
Subscription: 'subscription',
|
|
42
|
+
CreditTopup: 'credit_topup'
|
|
43
|
+
};
|
|
39
44
|
exports.DataTypesCreatePluralDeclensionRequestTypeEnum = {
|
|
40
45
|
Custom: 'custom',
|
|
41
46
|
Default: 'default'
|
|
@@ -1756,12 +1761,17 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1756
1761
|
};
|
|
1757
1762
|
}),
|
|
1758
1763
|
/**
|
|
1759
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
1764
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
1760
1765
|
* @summary Get No-Clicks Queries
|
|
1761
1766
|
* @param {string} xStoreID Store ID
|
|
1762
1767
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
1763
1768
|
* @param {string} [endTime] End time in RFC3339 format
|
|
1764
1769
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
1770
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
1771
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
1772
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
1773
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
1774
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
1765
1775
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
1766
1776
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
1767
1777
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -1780,7 +1790,7 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1780
1790
|
* @param {*} [options] Override http request option.
|
|
1781
1791
|
* @throws {RequiredError}
|
|
1782
1792
|
*/
|
|
1783
|
-
adminAnalyticsStoreXStoreIDQueriesNoClicksGet: (xStoreID_1, startTime_1, endTime_1, search_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, limit_1, offset_1, page_1, pageSize_1, sortBy_1, sortOrder_1, sort_1, ...args_1) => __awaiter(this, [xStoreID_1, startTime_1, endTime_1, search_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, limit_1, offset_1, page_1, pageSize_1, sortBy_1, sortOrder_1, sort_1, ...args_1], void 0, function* (xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options = {}) {
|
|
1793
|
+
adminAnalyticsStoreXStoreIDQueriesNoClicksGet: (xStoreID_1, startTime_1, endTime_1, search_1, analyticsTags_1, tagsMatchMode_1, tagsExclude_1, tagKeyFilter_1, tagValueFilter_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, limit_1, offset_1, page_1, pageSize_1, sortBy_1, sortOrder_1, sort_1, ...args_1) => __awaiter(this, [xStoreID_1, startTime_1, endTime_1, search_1, analyticsTags_1, tagsMatchMode_1, tagsExclude_1, tagKeyFilter_1, tagValueFilter_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, limit_1, offset_1, page_1, pageSize_1, sortBy_1, sortOrder_1, sort_1, ...args_1], void 0, function* (xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options = {}) {
|
|
1784
1794
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
1785
1795
|
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQueriesNoClicksGet', 'xStoreID', xStoreID);
|
|
1786
1796
|
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/no-clicks`
|
|
@@ -1805,6 +1815,21 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1805
1815
|
if (search !== undefined) {
|
|
1806
1816
|
localVarQueryParameter['search'] = search;
|
|
1807
1817
|
}
|
|
1818
|
+
if (analyticsTags !== undefined) {
|
|
1819
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
1820
|
+
}
|
|
1821
|
+
if (tagsMatchMode !== undefined) {
|
|
1822
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
1823
|
+
}
|
|
1824
|
+
if (tagsExclude !== undefined) {
|
|
1825
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
1826
|
+
}
|
|
1827
|
+
if (tagKeyFilter !== undefined) {
|
|
1828
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
1829
|
+
}
|
|
1830
|
+
if (tagValueFilter !== undefined) {
|
|
1831
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
1832
|
+
}
|
|
1808
1833
|
if (compareMode !== undefined) {
|
|
1809
1834
|
localVarQueryParameter['compare_mode'] = compareMode;
|
|
1810
1835
|
}
|
|
@@ -1859,12 +1884,17 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1859
1884
|
};
|
|
1860
1885
|
}),
|
|
1861
1886
|
/**
|
|
1862
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
1887
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
1863
1888
|
* @summary Get No-Results Queries
|
|
1864
1889
|
* @param {string} xStoreID Store ID
|
|
1865
1890
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
1866
1891
|
* @param {string} [endTime] End time in RFC3339 format
|
|
1867
1892
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
1893
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
1894
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
1895
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
1896
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
1897
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
1868
1898
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
1869
1899
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
1870
1900
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -1883,7 +1913,7 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1883
1913
|
* @param {*} [options] Override http request option.
|
|
1884
1914
|
* @throws {RequiredError}
|
|
1885
1915
|
*/
|
|
1886
|
-
adminAnalyticsStoreXStoreIDQueriesNoResultsGet: (xStoreID_1, startTime_1, endTime_1, search_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, limit_1, offset_1, page_1, pageSize_1, sortBy_1, sortOrder_1, sort_1, ...args_1) => __awaiter(this, [xStoreID_1, startTime_1, endTime_1, search_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, limit_1, offset_1, page_1, pageSize_1, sortBy_1, sortOrder_1, sort_1, ...args_1], void 0, function* (xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options = {}) {
|
|
1916
|
+
adminAnalyticsStoreXStoreIDQueriesNoResultsGet: (xStoreID_1, startTime_1, endTime_1, search_1, analyticsTags_1, tagsMatchMode_1, tagsExclude_1, tagKeyFilter_1, tagValueFilter_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, limit_1, offset_1, page_1, pageSize_1, sortBy_1, sortOrder_1, sort_1, ...args_1) => __awaiter(this, [xStoreID_1, startTime_1, endTime_1, search_1, analyticsTags_1, tagsMatchMode_1, tagsExclude_1, tagKeyFilter_1, tagValueFilter_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, limit_1, offset_1, page_1, pageSize_1, sortBy_1, sortOrder_1, sort_1, ...args_1], void 0, function* (xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options = {}) {
|
|
1887
1917
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
1888
1918
|
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQueriesNoResultsGet', 'xStoreID', xStoreID);
|
|
1889
1919
|
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/no-results`
|
|
@@ -1908,6 +1938,21 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1908
1938
|
if (search !== undefined) {
|
|
1909
1939
|
localVarQueryParameter['search'] = search;
|
|
1910
1940
|
}
|
|
1941
|
+
if (analyticsTags !== undefined) {
|
|
1942
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
1943
|
+
}
|
|
1944
|
+
if (tagsMatchMode !== undefined) {
|
|
1945
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
1946
|
+
}
|
|
1947
|
+
if (tagsExclude !== undefined) {
|
|
1948
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
1949
|
+
}
|
|
1950
|
+
if (tagKeyFilter !== undefined) {
|
|
1951
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
1952
|
+
}
|
|
1953
|
+
if (tagValueFilter !== undefined) {
|
|
1954
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
1955
|
+
}
|
|
1911
1956
|
if (compareMode !== undefined) {
|
|
1912
1957
|
localVarQueryParameter['compare_mode'] = compareMode;
|
|
1913
1958
|
}
|
|
@@ -1962,16 +2007,21 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1962
2007
|
};
|
|
1963
2008
|
}),
|
|
1964
2009
|
/**
|
|
1965
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
2010
|
+
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
|
|
1966
2011
|
* @summary Get Query Insights
|
|
1967
2012
|
* @param {string} xStoreID Store ID
|
|
1968
2013
|
* @param {string} query Search query to analyze
|
|
1969
2014
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
1970
2015
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2016
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
2017
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
2018
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
2019
|
+
* @param {number} [filtersPageSize] Number of filters per page for popular filters
|
|
2020
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
1971
2021
|
* @param {*} [options] Override http request option.
|
|
1972
2022
|
* @throws {RequiredError}
|
|
1973
2023
|
*/
|
|
1974
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: (xStoreID_1, query_1, startTime_1, endTime_1, ...args_1) => __awaiter(this, [xStoreID_1, query_1, startTime_1, endTime_1, ...args_1], void 0, function* (xStoreID, query, startTime, endTime, options = {}) {
|
|
2024
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: (xStoreID_1, query_1, startTime_1, endTime_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, includeWidget_1, ...args_1) => __awaiter(this, [xStoreID_1, query_1, startTime_1, endTime_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, includeWidget_1, ...args_1], void 0, function* (xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options = {}) {
|
|
1975
2025
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
1976
2026
|
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet', 'xStoreID', xStoreID);
|
|
1977
2027
|
// verify required parameter 'query' is not null or undefined
|
|
@@ -1996,6 +2046,21 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1996
2046
|
if (endTime !== undefined) {
|
|
1997
2047
|
localVarQueryParameter['end_time'] = endTime;
|
|
1998
2048
|
}
|
|
2049
|
+
if (resultsPage !== undefined) {
|
|
2050
|
+
localVarQueryParameter['results_page'] = resultsPage;
|
|
2051
|
+
}
|
|
2052
|
+
if (resultsPageSize !== undefined) {
|
|
2053
|
+
localVarQueryParameter['results_page_size'] = resultsPageSize;
|
|
2054
|
+
}
|
|
2055
|
+
if (filtersPage !== undefined) {
|
|
2056
|
+
localVarQueryParameter['filters_page'] = filtersPage;
|
|
2057
|
+
}
|
|
2058
|
+
if (filtersPageSize !== undefined) {
|
|
2059
|
+
localVarQueryParameter['filters_page_size'] = filtersPageSize;
|
|
2060
|
+
}
|
|
2061
|
+
if (includeWidget !== undefined) {
|
|
2062
|
+
localVarQueryParameter['include_widget'] = includeWidget;
|
|
2063
|
+
}
|
|
1999
2064
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2000
2065
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2001
2066
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -2005,12 +2070,25 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2005
2070
|
};
|
|
2006
2071
|
}),
|
|
2007
2072
|
/**
|
|
2008
|
-
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards.
|
|
2073
|
+
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
2009
2074
|
* @summary Get Top Results Analytics
|
|
2010
2075
|
* @param {string} xStoreID Store ID
|
|
2011
2076
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2012
2077
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2013
2078
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
2079
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2080
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2081
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2082
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2083
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2084
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2085
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2086
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2087
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2088
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2089
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2090
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2091
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2014
2092
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
2015
2093
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
2016
2094
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
@@ -2024,7 +2102,7 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2024
2102
|
* @param {*} [options] Override http request option.
|
|
2025
2103
|
* @throws {RequiredError}
|
|
2026
2104
|
*/
|
|
2027
|
-
adminAnalyticsStoreXStoreIDResultsGet: (xStoreID_1, startTime_1, endTime_1, itemIds_1, minImpressions_1, sortBy_1, sortOrder_1, sort_1, includeDocuments_1, includeWidget_1, limit_1, offset_1, page_1, pageSize_1, ...args_1) => __awaiter(this, [xStoreID_1, startTime_1, endTime_1, itemIds_1, minImpressions_1, sortBy_1, sortOrder_1, sort_1, includeDocuments_1, includeWidget_1, limit_1, offset_1, page_1, pageSize_1, ...args_1], void 0, function* (xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options = {}) {
|
|
2105
|
+
adminAnalyticsStoreXStoreIDResultsGet: (xStoreID_1, startTime_1, endTime_1, itemIds_1, analyticsTags_1, tagsMatchMode_1, tagsExclude_1, tagKeyFilter_1, tagValueFilter_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, minImpressions_1, sortBy_1, sortOrder_1, sort_1, includeDocuments_1, includeWidget_1, limit_1, offset_1, page_1, pageSize_1, ...args_1) => __awaiter(this, [xStoreID_1, startTime_1, endTime_1, itemIds_1, analyticsTags_1, tagsMatchMode_1, tagsExclude_1, tagKeyFilter_1, tagValueFilter_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, minImpressions_1, sortBy_1, sortOrder_1, sort_1, includeDocuments_1, includeWidget_1, limit_1, offset_1, page_1, pageSize_1, ...args_1], void 0, function* (xStoreID, startTime, endTime, itemIds, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options = {}) {
|
|
2028
2106
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
2029
2107
|
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDResultsGet', 'xStoreID', xStoreID);
|
|
2030
2108
|
const localVarPath = `/admin/analytics/store/{xStoreID}/results`
|
|
@@ -2049,6 +2127,45 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2049
2127
|
if (itemIds !== undefined) {
|
|
2050
2128
|
localVarQueryParameter['item_ids'] = itemIds;
|
|
2051
2129
|
}
|
|
2130
|
+
if (analyticsTags !== undefined) {
|
|
2131
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
2132
|
+
}
|
|
2133
|
+
if (tagsMatchMode !== undefined) {
|
|
2134
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
2135
|
+
}
|
|
2136
|
+
if (tagsExclude !== undefined) {
|
|
2137
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
2138
|
+
}
|
|
2139
|
+
if (tagKeyFilter !== undefined) {
|
|
2140
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
2141
|
+
}
|
|
2142
|
+
if (tagValueFilter !== undefined) {
|
|
2143
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
2144
|
+
}
|
|
2145
|
+
if (compareMode !== undefined) {
|
|
2146
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
2147
|
+
}
|
|
2148
|
+
if (compareStartTime !== undefined) {
|
|
2149
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
2150
|
+
}
|
|
2151
|
+
if (compareEndTime !== undefined) {
|
|
2152
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
2153
|
+
}
|
|
2154
|
+
if (compareAnalyticsTags !== undefined) {
|
|
2155
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
2156
|
+
}
|
|
2157
|
+
if (compareTagsMatchMode !== undefined) {
|
|
2158
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
2159
|
+
}
|
|
2160
|
+
if (compareTagsExclude !== undefined) {
|
|
2161
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
2162
|
+
}
|
|
2163
|
+
if (compareTagKeyFilter !== undefined) {
|
|
2164
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
2165
|
+
}
|
|
2166
|
+
if (compareTagValueFilter !== undefined) {
|
|
2167
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
2168
|
+
}
|
|
2052
2169
|
if (minImpressions !== undefined) {
|
|
2053
2170
|
localVarQueryParameter['min_impressions'] = minImpressions;
|
|
2054
2171
|
}
|
|
@@ -2533,12 +2650,17 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2533
2650
|
});
|
|
2534
2651
|
},
|
|
2535
2652
|
/**
|
|
2536
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
2653
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
2537
2654
|
* @summary Get No-Clicks Queries
|
|
2538
2655
|
* @param {string} xStoreID Store ID
|
|
2539
2656
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2540
2657
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2541
2658
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
2659
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2660
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2661
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2662
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2663
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2542
2664
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2543
2665
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2544
2666
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -2557,22 +2679,27 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2557
2679
|
* @param {*} [options] Override http request option.
|
|
2558
2680
|
* @throws {RequiredError}
|
|
2559
2681
|
*/
|
|
2560
|
-
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2682
|
+
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2561
2683
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2562
2684
|
var _a, _b, _c;
|
|
2563
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
2685
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
2564
2686
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2565
2687
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesNoClicksGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2566
2688
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2567
2689
|
});
|
|
2568
2690
|
},
|
|
2569
2691
|
/**
|
|
2570
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
2692
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
2571
2693
|
* @summary Get No-Results Queries
|
|
2572
2694
|
* @param {string} xStoreID Store ID
|
|
2573
2695
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2574
2696
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2575
2697
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
2698
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2699
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2700
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2701
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2702
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2576
2703
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2577
2704
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2578
2705
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -2591,41 +2718,59 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2591
2718
|
* @param {*} [options] Override http request option.
|
|
2592
2719
|
* @throws {RequiredError}
|
|
2593
2720
|
*/
|
|
2594
|
-
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2721
|
+
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2595
2722
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2596
2723
|
var _a, _b, _c;
|
|
2597
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
2724
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
2598
2725
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2599
2726
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesNoResultsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2600
2727
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2601
2728
|
});
|
|
2602
2729
|
},
|
|
2603
2730
|
/**
|
|
2604
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
2731
|
+
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
|
|
2605
2732
|
* @summary Get Query Insights
|
|
2606
2733
|
* @param {string} xStoreID Store ID
|
|
2607
2734
|
* @param {string} query Search query to analyze
|
|
2608
2735
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2609
2736
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2737
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
2738
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
2739
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
2740
|
+
* @param {number} [filtersPageSize] Number of filters per page for popular filters
|
|
2741
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
2610
2742
|
* @param {*} [options] Override http request option.
|
|
2611
2743
|
* @throws {RequiredError}
|
|
2612
2744
|
*/
|
|
2613
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options) {
|
|
2745
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
|
|
2614
2746
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2615
2747
|
var _a, _b, _c;
|
|
2616
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options);
|
|
2748
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options);
|
|
2617
2749
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2618
2750
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2619
2751
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2620
2752
|
});
|
|
2621
2753
|
},
|
|
2622
2754
|
/**
|
|
2623
|
-
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards.
|
|
2755
|
+
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
2624
2756
|
* @summary Get Top Results Analytics
|
|
2625
2757
|
* @param {string} xStoreID Store ID
|
|
2626
2758
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2627
2759
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2628
2760
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
2761
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2762
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2763
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2764
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2765
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2766
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2767
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2768
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2769
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2770
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2771
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2772
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2773
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2629
2774
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
2630
2775
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
2631
2776
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
@@ -2639,10 +2784,10 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2639
2784
|
* @param {*} [options] Override http request option.
|
|
2640
2785
|
* @throws {RequiredError}
|
|
2641
2786
|
*/
|
|
2642
|
-
adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options) {
|
|
2787
|
+
adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options) {
|
|
2643
2788
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2644
2789
|
var _a, _b, _c;
|
|
2645
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options);
|
|
2790
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options);
|
|
2646
2791
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2647
2792
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDResultsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2648
2793
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2936,12 +3081,17 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2936
3081
|
return localVarFp.adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
2937
3082
|
},
|
|
2938
3083
|
/**
|
|
2939
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
3084
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
2940
3085
|
* @summary Get No-Clicks Queries
|
|
2941
3086
|
* @param {string} xStoreID Store ID
|
|
2942
3087
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2943
3088
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2944
3089
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
3090
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3091
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3092
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3093
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3094
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2945
3095
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2946
3096
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2947
3097
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -2960,16 +3110,21 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2960
3110
|
* @param {*} [options] Override http request option.
|
|
2961
3111
|
* @throws {RequiredError}
|
|
2962
3112
|
*/
|
|
2963
|
-
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2964
|
-
return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
3113
|
+
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
3114
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
2965
3115
|
},
|
|
2966
3116
|
/**
|
|
2967
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
3117
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
2968
3118
|
* @summary Get No-Results Queries
|
|
2969
3119
|
* @param {string} xStoreID Store ID
|
|
2970
3120
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2971
3121
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2972
3122
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
3123
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3124
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3125
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3126
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3127
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2973
3128
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2974
3129
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2975
3130
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -2988,29 +3143,47 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2988
3143
|
* @param {*} [options] Override http request option.
|
|
2989
3144
|
* @throws {RequiredError}
|
|
2990
3145
|
*/
|
|
2991
|
-
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2992
|
-
return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
3146
|
+
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
3147
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
2993
3148
|
},
|
|
2994
3149
|
/**
|
|
2995
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
3150
|
+
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
|
|
2996
3151
|
* @summary Get Query Insights
|
|
2997
3152
|
* @param {string} xStoreID Store ID
|
|
2998
3153
|
* @param {string} query Search query to analyze
|
|
2999
3154
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3000
3155
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3156
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
3157
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
3158
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
3159
|
+
* @param {number} [filtersPageSize] Number of filters per page for popular filters
|
|
3160
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
3001
3161
|
* @param {*} [options] Override http request option.
|
|
3002
3162
|
* @throws {RequiredError}
|
|
3003
3163
|
*/
|
|
3004
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options) {
|
|
3005
|
-
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options).then((request) => request(axios, basePath));
|
|
3164
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
|
|
3165
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(axios, basePath));
|
|
3006
3166
|
},
|
|
3007
3167
|
/**
|
|
3008
|
-
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards.
|
|
3168
|
+
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
3009
3169
|
* @summary Get Top Results Analytics
|
|
3010
3170
|
* @param {string} xStoreID Store ID
|
|
3011
3171
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3012
3172
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3013
3173
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
3174
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3175
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3176
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3177
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3178
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3179
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3180
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3181
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3182
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3183
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3184
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3185
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3186
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3014
3187
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
3015
3188
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
3016
3189
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
@@ -3024,8 +3197,8 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
3024
3197
|
* @param {*} [options] Override http request option.
|
|
3025
3198
|
* @throws {RequiredError}
|
|
3026
3199
|
*/
|
|
3027
|
-
adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options) {
|
|
3028
|
-
return localVarFp.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options).then((request) => request(axios, basePath));
|
|
3200
|
+
adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options) {
|
|
3201
|
+
return localVarFp.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options).then((request) => request(axios, basePath));
|
|
3029
3202
|
},
|
|
3030
3203
|
/**
|
|
3031
3204
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
@@ -3314,12 +3487,17 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
3314
3487
|
return (0, exports.AnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
3315
3488
|
}
|
|
3316
3489
|
/**
|
|
3317
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
3490
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
3318
3491
|
* @summary Get No-Clicks Queries
|
|
3319
3492
|
* @param {string} xStoreID Store ID
|
|
3320
3493
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3321
3494
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3322
3495
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
3496
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3497
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3498
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3499
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3500
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3323
3501
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3324
3502
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3325
3503
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -3339,16 +3517,21 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
3339
3517
|
* @throws {RequiredError}
|
|
3340
3518
|
* @memberof AnalyticsApi
|
|
3341
3519
|
*/
|
|
3342
|
-
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
3343
|
-
return (0, exports.AnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
3520
|
+
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
3521
|
+
return (0, exports.AnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
3344
3522
|
}
|
|
3345
3523
|
/**
|
|
3346
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
3524
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
3347
3525
|
* @summary Get No-Results Queries
|
|
3348
3526
|
* @param {string} xStoreID Store ID
|
|
3349
3527
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3350
3528
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3351
3529
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
3530
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3531
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3532
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3533
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3534
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3352
3535
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3353
3536
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3354
3537
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -3368,30 +3551,48 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
3368
3551
|
* @throws {RequiredError}
|
|
3369
3552
|
* @memberof AnalyticsApi
|
|
3370
3553
|
*/
|
|
3371
|
-
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
3372
|
-
return (0, exports.AnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
3554
|
+
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
3555
|
+
return (0, exports.AnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
3373
3556
|
}
|
|
3374
3557
|
/**
|
|
3375
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
3558
|
+
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
|
|
3376
3559
|
* @summary Get Query Insights
|
|
3377
3560
|
* @param {string} xStoreID Store ID
|
|
3378
3561
|
* @param {string} query Search query to analyze
|
|
3379
3562
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3380
3563
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3564
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
3565
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
3566
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
3567
|
+
* @param {number} [filtersPageSize] Number of filters per page for popular filters
|
|
3568
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
3381
3569
|
* @param {*} [options] Override http request option.
|
|
3382
3570
|
* @throws {RequiredError}
|
|
3383
3571
|
* @memberof AnalyticsApi
|
|
3384
3572
|
*/
|
|
3385
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options) {
|
|
3386
|
-
return (0, exports.AnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options).then((request) => request(this.axios, this.basePath));
|
|
3573
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
|
|
3574
|
+
return (0, exports.AnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(this.axios, this.basePath));
|
|
3387
3575
|
}
|
|
3388
3576
|
/**
|
|
3389
|
-
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards.
|
|
3577
|
+
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
3390
3578
|
* @summary Get Top Results Analytics
|
|
3391
3579
|
* @param {string} xStoreID Store ID
|
|
3392
3580
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3393
3581
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3394
3582
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
3583
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3584
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3585
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3586
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3587
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3588
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3589
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3590
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3591
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3592
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3593
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3594
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3595
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3395
3596
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
3396
3597
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
3397
3598
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
@@ -3406,8 +3607,8 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
3406
3607
|
* @throws {RequiredError}
|
|
3407
3608
|
* @memberof AnalyticsApi
|
|
3408
3609
|
*/
|
|
3409
|
-
adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options) {
|
|
3410
|
-
return (0, exports.AnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
3610
|
+
adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options) {
|
|
3611
|
+
return (0, exports.AnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
3411
3612
|
}
|
|
3412
3613
|
/**
|
|
3413
3614
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
@@ -3655,6 +3856,13 @@ exports.AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum = {
|
|
|
3655
3856
|
Asc: 'asc',
|
|
3656
3857
|
Desc: 'desc'
|
|
3657
3858
|
};
|
|
3859
|
+
/**
|
|
3860
|
+
* @export
|
|
3861
|
+
*/
|
|
3862
|
+
exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum = {
|
|
3863
|
+
Any: 'any',
|
|
3864
|
+
All: 'all'
|
|
3865
|
+
};
|
|
3658
3866
|
/**
|
|
3659
3867
|
* @export
|
|
3660
3868
|
*/
|
|
@@ -3677,6 +3885,13 @@ exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum = {
|
|
|
3677
3885
|
Asc: 'asc',
|
|
3678
3886
|
Desc: 'desc'
|
|
3679
3887
|
};
|
|
3888
|
+
/**
|
|
3889
|
+
* @export
|
|
3890
|
+
*/
|
|
3891
|
+
exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum = {
|
|
3892
|
+
Any: 'any',
|
|
3893
|
+
All: 'all'
|
|
3894
|
+
};
|
|
3680
3895
|
/**
|
|
3681
3896
|
* @export
|
|
3682
3897
|
*/
|
|
@@ -3699,6 +3914,20 @@ exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = {
|
|
|
3699
3914
|
Asc: 'asc',
|
|
3700
3915
|
Desc: 'desc'
|
|
3701
3916
|
};
|
|
3917
|
+
/**
|
|
3918
|
+
* @export
|
|
3919
|
+
*/
|
|
3920
|
+
exports.AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum = {
|
|
3921
|
+
Any: 'any',
|
|
3922
|
+
All: 'all'
|
|
3923
|
+
};
|
|
3924
|
+
/**
|
|
3925
|
+
* @export
|
|
3926
|
+
*/
|
|
3927
|
+
exports.AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum = {
|
|
3928
|
+
Any: 'any',
|
|
3929
|
+
All: 'all'
|
|
3930
|
+
};
|
|
3702
3931
|
/**
|
|
3703
3932
|
* @export
|
|
3704
3933
|
*/
|
|
@@ -12030,6 +12259,373 @@ class ParentMenusApi extends base_1.BaseAPI {
|
|
|
12030
12259
|
}
|
|
12031
12260
|
}
|
|
12032
12261
|
exports.ParentMenusApi = ParentMenusApi;
|
|
12262
|
+
/**
|
|
12263
|
+
* PaymentGatewayApi - axios parameter creator
|
|
12264
|
+
* @export
|
|
12265
|
+
*/
|
|
12266
|
+
const PaymentGatewayApiAxiosParamCreator = function (configuration) {
|
|
12267
|
+
return {
|
|
12268
|
+
/**
|
|
12269
|
+
* Creates a payment order using specified or default payment gateway
|
|
12270
|
+
* @summary Create a new payment order
|
|
12271
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
12272
|
+
* @param {*} [options] Override http request option.
|
|
12273
|
+
* @throws {RequiredError}
|
|
12274
|
+
*/
|
|
12275
|
+
paymentGatewayCreateOrderPost: (order_1, ...args_1) => __awaiter(this, [order_1, ...args_1], void 0, function* (order, options = {}) {
|
|
12276
|
+
// verify required parameter 'order' is not null or undefined
|
|
12277
|
+
(0, common_1.assertParamExists)('paymentGatewayCreateOrderPost', 'order', order);
|
|
12278
|
+
const localVarPath = `/payment-gateway/create-order`;
|
|
12279
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12280
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
12281
|
+
let baseOptions;
|
|
12282
|
+
if (configuration) {
|
|
12283
|
+
baseOptions = configuration.baseOptions;
|
|
12284
|
+
}
|
|
12285
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
12286
|
+
const localVarHeaderParameter = {};
|
|
12287
|
+
const localVarQueryParameter = {};
|
|
12288
|
+
// authentication BearerAuth required
|
|
12289
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
12290
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
12291
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
12292
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12293
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12294
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(order, localVarRequestOptions, configuration);
|
|
12295
|
+
return {
|
|
12296
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
12297
|
+
options: localVarRequestOptions,
|
|
12298
|
+
};
|
|
12299
|
+
}),
|
|
12300
|
+
/**
|
|
12301
|
+
* Returns list of all active credit plans for purchase
|
|
12302
|
+
* @summary Get available credit plans
|
|
12303
|
+
* @param {*} [options] Override http request option.
|
|
12304
|
+
* @throws {RequiredError}
|
|
12305
|
+
*/
|
|
12306
|
+
paymentGatewayCreditPlansGet: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
12307
|
+
const localVarPath = `/payment-gateway/credit-plans`;
|
|
12308
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12309
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
12310
|
+
let baseOptions;
|
|
12311
|
+
if (configuration) {
|
|
12312
|
+
baseOptions = configuration.baseOptions;
|
|
12313
|
+
}
|
|
12314
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
12315
|
+
const localVarHeaderParameter = {};
|
|
12316
|
+
const localVarQueryParameter = {};
|
|
12317
|
+
// authentication BearerAuth required
|
|
12318
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
12319
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
12320
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12321
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12322
|
+
return {
|
|
12323
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
12324
|
+
options: localVarRequestOptions,
|
|
12325
|
+
};
|
|
12326
|
+
}),
|
|
12327
|
+
/**
|
|
12328
|
+
* Returns list of all available payment gateways
|
|
12329
|
+
* @summary Get available payment gateways
|
|
12330
|
+
* @param {*} [options] Override http request option.
|
|
12331
|
+
* @throws {RequiredError}
|
|
12332
|
+
*/
|
|
12333
|
+
paymentGatewayGatewaysGet: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
12334
|
+
const localVarPath = `/payment-gateway/gateways`;
|
|
12335
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12336
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
12337
|
+
let baseOptions;
|
|
12338
|
+
if (configuration) {
|
|
12339
|
+
baseOptions = configuration.baseOptions;
|
|
12340
|
+
}
|
|
12341
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
12342
|
+
const localVarHeaderParameter = {};
|
|
12343
|
+
const localVarQueryParameter = {};
|
|
12344
|
+
// authentication BearerAuth required
|
|
12345
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
12346
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
12347
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12348
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12349
|
+
return {
|
|
12350
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
12351
|
+
options: localVarRequestOptions,
|
|
12352
|
+
};
|
|
12353
|
+
}),
|
|
12354
|
+
/**
|
|
12355
|
+
* Processes a refund for a completed payment
|
|
12356
|
+
* @summary Process payment refund
|
|
12357
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
12358
|
+
* @param {*} [options] Override http request option.
|
|
12359
|
+
* @throws {RequiredError}
|
|
12360
|
+
*/
|
|
12361
|
+
paymentGatewayRefundPost: (refund_1, ...args_1) => __awaiter(this, [refund_1, ...args_1], void 0, function* (refund, options = {}) {
|
|
12362
|
+
// verify required parameter 'refund' is not null or undefined
|
|
12363
|
+
(0, common_1.assertParamExists)('paymentGatewayRefundPost', 'refund', refund);
|
|
12364
|
+
const localVarPath = `/payment-gateway/refund`;
|
|
12365
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12366
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
12367
|
+
let baseOptions;
|
|
12368
|
+
if (configuration) {
|
|
12369
|
+
baseOptions = configuration.baseOptions;
|
|
12370
|
+
}
|
|
12371
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
12372
|
+
const localVarHeaderParameter = {};
|
|
12373
|
+
const localVarQueryParameter = {};
|
|
12374
|
+
// authentication BearerAuth required
|
|
12375
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
12376
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
12377
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
12378
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12379
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12380
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(refund, localVarRequestOptions, configuration);
|
|
12381
|
+
return {
|
|
12382
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
12383
|
+
options: localVarRequestOptions,
|
|
12384
|
+
};
|
|
12385
|
+
}),
|
|
12386
|
+
/**
|
|
12387
|
+
* Verifies the current status of a payment
|
|
12388
|
+
* @summary Verify payment status
|
|
12389
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
12390
|
+
* @param {*} [options] Override http request option.
|
|
12391
|
+
* @throws {RequiredError}
|
|
12392
|
+
*/
|
|
12393
|
+
paymentGatewayVerifyPost: (verify_1, ...args_1) => __awaiter(this, [verify_1, ...args_1], void 0, function* (verify, options = {}) {
|
|
12394
|
+
// verify required parameter 'verify' is not null or undefined
|
|
12395
|
+
(0, common_1.assertParamExists)('paymentGatewayVerifyPost', 'verify', verify);
|
|
12396
|
+
const localVarPath = `/payment-gateway/verify`;
|
|
12397
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12398
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
12399
|
+
let baseOptions;
|
|
12400
|
+
if (configuration) {
|
|
12401
|
+
baseOptions = configuration.baseOptions;
|
|
12402
|
+
}
|
|
12403
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
12404
|
+
const localVarHeaderParameter = {};
|
|
12405
|
+
const localVarQueryParameter = {};
|
|
12406
|
+
// authentication BearerAuth required
|
|
12407
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
12408
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
12409
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
12410
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12411
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12412
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(verify, localVarRequestOptions, configuration);
|
|
12413
|
+
return {
|
|
12414
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
12415
|
+
options: localVarRequestOptions,
|
|
12416
|
+
};
|
|
12417
|
+
}),
|
|
12418
|
+
};
|
|
12419
|
+
};
|
|
12420
|
+
exports.PaymentGatewayApiAxiosParamCreator = PaymentGatewayApiAxiosParamCreator;
|
|
12421
|
+
/**
|
|
12422
|
+
* PaymentGatewayApi - functional programming interface
|
|
12423
|
+
* @export
|
|
12424
|
+
*/
|
|
12425
|
+
const PaymentGatewayApiFp = function (configuration) {
|
|
12426
|
+
const localVarAxiosParamCreator = (0, exports.PaymentGatewayApiAxiosParamCreator)(configuration);
|
|
12427
|
+
return {
|
|
12428
|
+
/**
|
|
12429
|
+
* Creates a payment order using specified or default payment gateway
|
|
12430
|
+
* @summary Create a new payment order
|
|
12431
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
12432
|
+
* @param {*} [options] Override http request option.
|
|
12433
|
+
* @throws {RequiredError}
|
|
12434
|
+
*/
|
|
12435
|
+
paymentGatewayCreateOrderPost(order, options) {
|
|
12436
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12437
|
+
var _a, _b, _c;
|
|
12438
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayCreateOrderPost(order, options);
|
|
12439
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12440
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['PaymentGatewayApi.paymentGatewayCreateOrderPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12441
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12442
|
+
});
|
|
12443
|
+
},
|
|
12444
|
+
/**
|
|
12445
|
+
* Returns list of all active credit plans for purchase
|
|
12446
|
+
* @summary Get available credit plans
|
|
12447
|
+
* @param {*} [options] Override http request option.
|
|
12448
|
+
* @throws {RequiredError}
|
|
12449
|
+
*/
|
|
12450
|
+
paymentGatewayCreditPlansGet(options) {
|
|
12451
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12452
|
+
var _a, _b, _c;
|
|
12453
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayCreditPlansGet(options);
|
|
12454
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12455
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['PaymentGatewayApi.paymentGatewayCreditPlansGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12456
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12457
|
+
});
|
|
12458
|
+
},
|
|
12459
|
+
/**
|
|
12460
|
+
* Returns list of all available payment gateways
|
|
12461
|
+
* @summary Get available payment gateways
|
|
12462
|
+
* @param {*} [options] Override http request option.
|
|
12463
|
+
* @throws {RequiredError}
|
|
12464
|
+
*/
|
|
12465
|
+
paymentGatewayGatewaysGet(options) {
|
|
12466
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12467
|
+
var _a, _b, _c;
|
|
12468
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayGatewaysGet(options);
|
|
12469
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12470
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['PaymentGatewayApi.paymentGatewayGatewaysGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12471
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12472
|
+
});
|
|
12473
|
+
},
|
|
12474
|
+
/**
|
|
12475
|
+
* Processes a refund for a completed payment
|
|
12476
|
+
* @summary Process payment refund
|
|
12477
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
12478
|
+
* @param {*} [options] Override http request option.
|
|
12479
|
+
* @throws {RequiredError}
|
|
12480
|
+
*/
|
|
12481
|
+
paymentGatewayRefundPost(refund, options) {
|
|
12482
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12483
|
+
var _a, _b, _c;
|
|
12484
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayRefundPost(refund, options);
|
|
12485
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12486
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['PaymentGatewayApi.paymentGatewayRefundPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12487
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12488
|
+
});
|
|
12489
|
+
},
|
|
12490
|
+
/**
|
|
12491
|
+
* Verifies the current status of a payment
|
|
12492
|
+
* @summary Verify payment status
|
|
12493
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
12494
|
+
* @param {*} [options] Override http request option.
|
|
12495
|
+
* @throws {RequiredError}
|
|
12496
|
+
*/
|
|
12497
|
+
paymentGatewayVerifyPost(verify, options) {
|
|
12498
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12499
|
+
var _a, _b, _c;
|
|
12500
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayVerifyPost(verify, options);
|
|
12501
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12502
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['PaymentGatewayApi.paymentGatewayVerifyPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12503
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12504
|
+
});
|
|
12505
|
+
},
|
|
12506
|
+
};
|
|
12507
|
+
};
|
|
12508
|
+
exports.PaymentGatewayApiFp = PaymentGatewayApiFp;
|
|
12509
|
+
/**
|
|
12510
|
+
* PaymentGatewayApi - factory interface
|
|
12511
|
+
* @export
|
|
12512
|
+
*/
|
|
12513
|
+
const PaymentGatewayApiFactory = function (configuration, basePath, axios) {
|
|
12514
|
+
const localVarFp = (0, exports.PaymentGatewayApiFp)(configuration);
|
|
12515
|
+
return {
|
|
12516
|
+
/**
|
|
12517
|
+
* Creates a payment order using specified or default payment gateway
|
|
12518
|
+
* @summary Create a new payment order
|
|
12519
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
12520
|
+
* @param {*} [options] Override http request option.
|
|
12521
|
+
* @throws {RequiredError}
|
|
12522
|
+
*/
|
|
12523
|
+
paymentGatewayCreateOrderPost(order, options) {
|
|
12524
|
+
return localVarFp.paymentGatewayCreateOrderPost(order, options).then((request) => request(axios, basePath));
|
|
12525
|
+
},
|
|
12526
|
+
/**
|
|
12527
|
+
* Returns list of all active credit plans for purchase
|
|
12528
|
+
* @summary Get available credit plans
|
|
12529
|
+
* @param {*} [options] Override http request option.
|
|
12530
|
+
* @throws {RequiredError}
|
|
12531
|
+
*/
|
|
12532
|
+
paymentGatewayCreditPlansGet(options) {
|
|
12533
|
+
return localVarFp.paymentGatewayCreditPlansGet(options).then((request) => request(axios, basePath));
|
|
12534
|
+
},
|
|
12535
|
+
/**
|
|
12536
|
+
* Returns list of all available payment gateways
|
|
12537
|
+
* @summary Get available payment gateways
|
|
12538
|
+
* @param {*} [options] Override http request option.
|
|
12539
|
+
* @throws {RequiredError}
|
|
12540
|
+
*/
|
|
12541
|
+
paymentGatewayGatewaysGet(options) {
|
|
12542
|
+
return localVarFp.paymentGatewayGatewaysGet(options).then((request) => request(axios, basePath));
|
|
12543
|
+
},
|
|
12544
|
+
/**
|
|
12545
|
+
* Processes a refund for a completed payment
|
|
12546
|
+
* @summary Process payment refund
|
|
12547
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
12548
|
+
* @param {*} [options] Override http request option.
|
|
12549
|
+
* @throws {RequiredError}
|
|
12550
|
+
*/
|
|
12551
|
+
paymentGatewayRefundPost(refund, options) {
|
|
12552
|
+
return localVarFp.paymentGatewayRefundPost(refund, options).then((request) => request(axios, basePath));
|
|
12553
|
+
},
|
|
12554
|
+
/**
|
|
12555
|
+
* Verifies the current status of a payment
|
|
12556
|
+
* @summary Verify payment status
|
|
12557
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
12558
|
+
* @param {*} [options] Override http request option.
|
|
12559
|
+
* @throws {RequiredError}
|
|
12560
|
+
*/
|
|
12561
|
+
paymentGatewayVerifyPost(verify, options) {
|
|
12562
|
+
return localVarFp.paymentGatewayVerifyPost(verify, options).then((request) => request(axios, basePath));
|
|
12563
|
+
},
|
|
12564
|
+
};
|
|
12565
|
+
};
|
|
12566
|
+
exports.PaymentGatewayApiFactory = PaymentGatewayApiFactory;
|
|
12567
|
+
/**
|
|
12568
|
+
* PaymentGatewayApi - object-oriented interface
|
|
12569
|
+
* @export
|
|
12570
|
+
* @class PaymentGatewayApi
|
|
12571
|
+
* @extends {BaseAPI}
|
|
12572
|
+
*/
|
|
12573
|
+
class PaymentGatewayApi extends base_1.BaseAPI {
|
|
12574
|
+
/**
|
|
12575
|
+
* Creates a payment order using specified or default payment gateway
|
|
12576
|
+
* @summary Create a new payment order
|
|
12577
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
12578
|
+
* @param {*} [options] Override http request option.
|
|
12579
|
+
* @throws {RequiredError}
|
|
12580
|
+
* @memberof PaymentGatewayApi
|
|
12581
|
+
*/
|
|
12582
|
+
paymentGatewayCreateOrderPost(order, options) {
|
|
12583
|
+
return (0, exports.PaymentGatewayApiFp)(this.configuration).paymentGatewayCreateOrderPost(order, options).then((request) => request(this.axios, this.basePath));
|
|
12584
|
+
}
|
|
12585
|
+
/**
|
|
12586
|
+
* Returns list of all active credit plans for purchase
|
|
12587
|
+
* @summary Get available credit plans
|
|
12588
|
+
* @param {*} [options] Override http request option.
|
|
12589
|
+
* @throws {RequiredError}
|
|
12590
|
+
* @memberof PaymentGatewayApi
|
|
12591
|
+
*/
|
|
12592
|
+
paymentGatewayCreditPlansGet(options) {
|
|
12593
|
+
return (0, exports.PaymentGatewayApiFp)(this.configuration).paymentGatewayCreditPlansGet(options).then((request) => request(this.axios, this.basePath));
|
|
12594
|
+
}
|
|
12595
|
+
/**
|
|
12596
|
+
* Returns list of all available payment gateways
|
|
12597
|
+
* @summary Get available payment gateways
|
|
12598
|
+
* @param {*} [options] Override http request option.
|
|
12599
|
+
* @throws {RequiredError}
|
|
12600
|
+
* @memberof PaymentGatewayApi
|
|
12601
|
+
*/
|
|
12602
|
+
paymentGatewayGatewaysGet(options) {
|
|
12603
|
+
return (0, exports.PaymentGatewayApiFp)(this.configuration).paymentGatewayGatewaysGet(options).then((request) => request(this.axios, this.basePath));
|
|
12604
|
+
}
|
|
12605
|
+
/**
|
|
12606
|
+
* Processes a refund for a completed payment
|
|
12607
|
+
* @summary Process payment refund
|
|
12608
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
12609
|
+
* @param {*} [options] Override http request option.
|
|
12610
|
+
* @throws {RequiredError}
|
|
12611
|
+
* @memberof PaymentGatewayApi
|
|
12612
|
+
*/
|
|
12613
|
+
paymentGatewayRefundPost(refund, options) {
|
|
12614
|
+
return (0, exports.PaymentGatewayApiFp)(this.configuration).paymentGatewayRefundPost(refund, options).then((request) => request(this.axios, this.basePath));
|
|
12615
|
+
}
|
|
12616
|
+
/**
|
|
12617
|
+
* Verifies the current status of a payment
|
|
12618
|
+
* @summary Verify payment status
|
|
12619
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
12620
|
+
* @param {*} [options] Override http request option.
|
|
12621
|
+
* @throws {RequiredError}
|
|
12622
|
+
* @memberof PaymentGatewayApi
|
|
12623
|
+
*/
|
|
12624
|
+
paymentGatewayVerifyPost(verify, options) {
|
|
12625
|
+
return (0, exports.PaymentGatewayApiFp)(this.configuration).paymentGatewayVerifyPost(verify, options).then((request) => request(this.axios, this.basePath));
|
|
12626
|
+
}
|
|
12627
|
+
}
|
|
12628
|
+
exports.PaymentGatewayApi = PaymentGatewayApi;
|
|
12033
12629
|
/**
|
|
12034
12630
|
* PaymentsApi - axios parameter creator
|
|
12035
12631
|
* @export
|