@seekora-ai/admin-api 1.0.46 → 1.0.47
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 +16 -2
- package/api.ts +1085 -70
- package/dist/api.d.ts +746 -24
- package/dist/api.js +598 -37
- package/dist/esm/api.d.ts +746 -24
- package/dist/esm/api.js +590 -33
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.0.47.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
|
}
|
|
@@ -2005,12 +2050,25 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2005
2050
|
};
|
|
2006
2051
|
}),
|
|
2007
2052
|
/**
|
|
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.
|
|
2053
|
+
* 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
2054
|
* @summary Get Top Results Analytics
|
|
2010
2055
|
* @param {string} xStoreID Store ID
|
|
2011
2056
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2012
2057
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2013
2058
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
2059
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2060
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2061
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2062
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2063
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2064
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2065
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2066
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2067
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2068
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2069
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2070
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2071
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2014
2072
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
2015
2073
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
2016
2074
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
@@ -2024,7 +2082,7 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2024
2082
|
* @param {*} [options] Override http request option.
|
|
2025
2083
|
* @throws {RequiredError}
|
|
2026
2084
|
*/
|
|
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 = {}) {
|
|
2085
|
+
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
2086
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
2029
2087
|
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDResultsGet', 'xStoreID', xStoreID);
|
|
2030
2088
|
const localVarPath = `/admin/analytics/store/{xStoreID}/results`
|
|
@@ -2049,6 +2107,45 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2049
2107
|
if (itemIds !== undefined) {
|
|
2050
2108
|
localVarQueryParameter['item_ids'] = itemIds;
|
|
2051
2109
|
}
|
|
2110
|
+
if (analyticsTags !== undefined) {
|
|
2111
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
2112
|
+
}
|
|
2113
|
+
if (tagsMatchMode !== undefined) {
|
|
2114
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
2115
|
+
}
|
|
2116
|
+
if (tagsExclude !== undefined) {
|
|
2117
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
2118
|
+
}
|
|
2119
|
+
if (tagKeyFilter !== undefined) {
|
|
2120
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
2121
|
+
}
|
|
2122
|
+
if (tagValueFilter !== undefined) {
|
|
2123
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
2124
|
+
}
|
|
2125
|
+
if (compareMode !== undefined) {
|
|
2126
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
2127
|
+
}
|
|
2128
|
+
if (compareStartTime !== undefined) {
|
|
2129
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
2130
|
+
}
|
|
2131
|
+
if (compareEndTime !== undefined) {
|
|
2132
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
2133
|
+
}
|
|
2134
|
+
if (compareAnalyticsTags !== undefined) {
|
|
2135
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
2136
|
+
}
|
|
2137
|
+
if (compareTagsMatchMode !== undefined) {
|
|
2138
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
2139
|
+
}
|
|
2140
|
+
if (compareTagsExclude !== undefined) {
|
|
2141
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
2142
|
+
}
|
|
2143
|
+
if (compareTagKeyFilter !== undefined) {
|
|
2144
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
2145
|
+
}
|
|
2146
|
+
if (compareTagValueFilter !== undefined) {
|
|
2147
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
2148
|
+
}
|
|
2052
2149
|
if (minImpressions !== undefined) {
|
|
2053
2150
|
localVarQueryParameter['min_impressions'] = minImpressions;
|
|
2054
2151
|
}
|
|
@@ -2533,12 +2630,17 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2533
2630
|
});
|
|
2534
2631
|
},
|
|
2535
2632
|
/**
|
|
2536
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
2633
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
2537
2634
|
* @summary Get No-Clicks Queries
|
|
2538
2635
|
* @param {string} xStoreID Store ID
|
|
2539
2636
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2540
2637
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2541
2638
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
2639
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2640
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2641
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2642
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2643
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2542
2644
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2543
2645
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2544
2646
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -2557,22 +2659,27 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2557
2659
|
* @param {*} [options] Override http request option.
|
|
2558
2660
|
* @throws {RequiredError}
|
|
2559
2661
|
*/
|
|
2560
|
-
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2662
|
+
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
2663
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2562
2664
|
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);
|
|
2665
|
+
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
2666
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2565
2667
|
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
2668
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2567
2669
|
});
|
|
2568
2670
|
},
|
|
2569
2671
|
/**
|
|
2570
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
2672
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
2571
2673
|
* @summary Get No-Results Queries
|
|
2572
2674
|
* @param {string} xStoreID Store ID
|
|
2573
2675
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2574
2676
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2575
2677
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
2678
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2679
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2680
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2681
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2682
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2576
2683
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2577
2684
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2578
2685
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -2591,10 +2698,10 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2591
2698
|
* @param {*} [options] Override http request option.
|
|
2592
2699
|
* @throws {RequiredError}
|
|
2593
2700
|
*/
|
|
2594
|
-
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2701
|
+
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
2702
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2596
2703
|
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);
|
|
2704
|
+
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
2705
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2599
2706
|
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
2707
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2620,12 +2727,25 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2620
2727
|
});
|
|
2621
2728
|
},
|
|
2622
2729
|
/**
|
|
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.
|
|
2730
|
+
* 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
2731
|
* @summary Get Top Results Analytics
|
|
2625
2732
|
* @param {string} xStoreID Store ID
|
|
2626
2733
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2627
2734
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2628
2735
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
2736
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2737
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2738
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2739
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2740
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2741
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2742
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2743
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2744
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2745
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2746
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2747
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2748
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2629
2749
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
2630
2750
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
2631
2751
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
@@ -2639,10 +2759,10 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2639
2759
|
* @param {*} [options] Override http request option.
|
|
2640
2760
|
* @throws {RequiredError}
|
|
2641
2761
|
*/
|
|
2642
|
-
adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options) {
|
|
2762
|
+
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
2763
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2644
2764
|
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);
|
|
2765
|
+
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
2766
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2647
2767
|
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
2768
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2936,12 +3056,17 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2936
3056
|
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
3057
|
},
|
|
2938
3058
|
/**
|
|
2939
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
3059
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
2940
3060
|
* @summary Get No-Clicks Queries
|
|
2941
3061
|
* @param {string} xStoreID Store ID
|
|
2942
3062
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2943
3063
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2944
3064
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
3065
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3066
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3067
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3068
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3069
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2945
3070
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2946
3071
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2947
3072
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -2960,16 +3085,21 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2960
3085
|
* @param {*} [options] Override http request option.
|
|
2961
3086
|
* @throws {RequiredError}
|
|
2962
3087
|
*/
|
|
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));
|
|
3088
|
+
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) {
|
|
3089
|
+
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
3090
|
},
|
|
2966
3091
|
/**
|
|
2967
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
3092
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
2968
3093
|
* @summary Get No-Results Queries
|
|
2969
3094
|
* @param {string} xStoreID Store ID
|
|
2970
3095
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2971
3096
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2972
3097
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
3098
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3099
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3100
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3101
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3102
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2973
3103
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2974
3104
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2975
3105
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -2988,8 +3118,8 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2988
3118
|
* @param {*} [options] Override http request option.
|
|
2989
3119
|
* @throws {RequiredError}
|
|
2990
3120
|
*/
|
|
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));
|
|
3121
|
+
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) {
|
|
3122
|
+
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
3123
|
},
|
|
2994
3124
|
/**
|
|
2995
3125
|
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
@@ -3005,12 +3135,25 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
3005
3135
|
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options).then((request) => request(axios, basePath));
|
|
3006
3136
|
},
|
|
3007
3137
|
/**
|
|
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.
|
|
3138
|
+
* 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
3139
|
* @summary Get Top Results Analytics
|
|
3010
3140
|
* @param {string} xStoreID Store ID
|
|
3011
3141
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3012
3142
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3013
3143
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
3144
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3145
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3146
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3147
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3148
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3149
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3150
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3151
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3152
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3153
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3154
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3155
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3156
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3014
3157
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
3015
3158
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
3016
3159
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
@@ -3024,8 +3167,8 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
3024
3167
|
* @param {*} [options] Override http request option.
|
|
3025
3168
|
* @throws {RequiredError}
|
|
3026
3169
|
*/
|
|
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));
|
|
3170
|
+
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) {
|
|
3171
|
+
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
3172
|
},
|
|
3030
3173
|
/**
|
|
3031
3174
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
@@ -3314,12 +3457,17 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
3314
3457
|
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
3458
|
}
|
|
3316
3459
|
/**
|
|
3317
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
3460
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
3318
3461
|
* @summary Get No-Clicks Queries
|
|
3319
3462
|
* @param {string} xStoreID Store ID
|
|
3320
3463
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3321
3464
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3322
3465
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
3466
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3467
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3468
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3469
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3470
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3323
3471
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3324
3472
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3325
3473
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -3339,16 +3487,21 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
3339
3487
|
* @throws {RequiredError}
|
|
3340
3488
|
* @memberof AnalyticsApi
|
|
3341
3489
|
*/
|
|
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));
|
|
3490
|
+
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) {
|
|
3491
|
+
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
3492
|
}
|
|
3345
3493
|
/**
|
|
3346
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
3494
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
3347
3495
|
* @summary Get No-Results Queries
|
|
3348
3496
|
* @param {string} xStoreID Store ID
|
|
3349
3497
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3350
3498
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3351
3499
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
3500
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3501
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3502
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3503
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3504
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3352
3505
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3353
3506
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3354
3507
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -3368,8 +3521,8 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
3368
3521
|
* @throws {RequiredError}
|
|
3369
3522
|
* @memberof AnalyticsApi
|
|
3370
3523
|
*/
|
|
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));
|
|
3524
|
+
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) {
|
|
3525
|
+
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
3526
|
}
|
|
3374
3527
|
/**
|
|
3375
3528
|
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
@@ -3386,12 +3539,25 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
3386
3539
|
return (0, exports.AnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options).then((request) => request(this.axios, this.basePath));
|
|
3387
3540
|
}
|
|
3388
3541
|
/**
|
|
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.
|
|
3542
|
+
* 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
3543
|
* @summary Get Top Results Analytics
|
|
3391
3544
|
* @param {string} xStoreID Store ID
|
|
3392
3545
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3393
3546
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3394
3547
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
3548
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3549
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3550
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3551
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3552
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3553
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3554
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3555
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3556
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3557
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3558
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3559
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3560
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3395
3561
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
3396
3562
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
3397
3563
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
@@ -3406,8 +3572,8 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
3406
3572
|
* @throws {RequiredError}
|
|
3407
3573
|
* @memberof AnalyticsApi
|
|
3408
3574
|
*/
|
|
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));
|
|
3575
|
+
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) {
|
|
3576
|
+
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
3577
|
}
|
|
3412
3578
|
/**
|
|
3413
3579
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
@@ -3655,6 +3821,13 @@ exports.AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum = {
|
|
|
3655
3821
|
Asc: 'asc',
|
|
3656
3822
|
Desc: 'desc'
|
|
3657
3823
|
};
|
|
3824
|
+
/**
|
|
3825
|
+
* @export
|
|
3826
|
+
*/
|
|
3827
|
+
exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum = {
|
|
3828
|
+
Any: 'any',
|
|
3829
|
+
All: 'all'
|
|
3830
|
+
};
|
|
3658
3831
|
/**
|
|
3659
3832
|
* @export
|
|
3660
3833
|
*/
|
|
@@ -3677,6 +3850,13 @@ exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum = {
|
|
|
3677
3850
|
Asc: 'asc',
|
|
3678
3851
|
Desc: 'desc'
|
|
3679
3852
|
};
|
|
3853
|
+
/**
|
|
3854
|
+
* @export
|
|
3855
|
+
*/
|
|
3856
|
+
exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum = {
|
|
3857
|
+
Any: 'any',
|
|
3858
|
+
All: 'all'
|
|
3859
|
+
};
|
|
3680
3860
|
/**
|
|
3681
3861
|
* @export
|
|
3682
3862
|
*/
|
|
@@ -3699,6 +3879,20 @@ exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = {
|
|
|
3699
3879
|
Asc: 'asc',
|
|
3700
3880
|
Desc: 'desc'
|
|
3701
3881
|
};
|
|
3882
|
+
/**
|
|
3883
|
+
* @export
|
|
3884
|
+
*/
|
|
3885
|
+
exports.AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum = {
|
|
3886
|
+
Any: 'any',
|
|
3887
|
+
All: 'all'
|
|
3888
|
+
};
|
|
3889
|
+
/**
|
|
3890
|
+
* @export
|
|
3891
|
+
*/
|
|
3892
|
+
exports.AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum = {
|
|
3893
|
+
Any: 'any',
|
|
3894
|
+
All: 'all'
|
|
3895
|
+
};
|
|
3702
3896
|
/**
|
|
3703
3897
|
* @export
|
|
3704
3898
|
*/
|
|
@@ -12030,6 +12224,373 @@ class ParentMenusApi extends base_1.BaseAPI {
|
|
|
12030
12224
|
}
|
|
12031
12225
|
}
|
|
12032
12226
|
exports.ParentMenusApi = ParentMenusApi;
|
|
12227
|
+
/**
|
|
12228
|
+
* PaymentGatewayApi - axios parameter creator
|
|
12229
|
+
* @export
|
|
12230
|
+
*/
|
|
12231
|
+
const PaymentGatewayApiAxiosParamCreator = function (configuration) {
|
|
12232
|
+
return {
|
|
12233
|
+
/**
|
|
12234
|
+
* Creates a payment order using specified or default payment gateway
|
|
12235
|
+
* @summary Create a new payment order
|
|
12236
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
12237
|
+
* @param {*} [options] Override http request option.
|
|
12238
|
+
* @throws {RequiredError}
|
|
12239
|
+
*/
|
|
12240
|
+
paymentGatewayCreateOrderPost: (order_1, ...args_1) => __awaiter(this, [order_1, ...args_1], void 0, function* (order, options = {}) {
|
|
12241
|
+
// verify required parameter 'order' is not null or undefined
|
|
12242
|
+
(0, common_1.assertParamExists)('paymentGatewayCreateOrderPost', 'order', order);
|
|
12243
|
+
const localVarPath = `/payment-gateway/create-order`;
|
|
12244
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12245
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
12246
|
+
let baseOptions;
|
|
12247
|
+
if (configuration) {
|
|
12248
|
+
baseOptions = configuration.baseOptions;
|
|
12249
|
+
}
|
|
12250
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
12251
|
+
const localVarHeaderParameter = {};
|
|
12252
|
+
const localVarQueryParameter = {};
|
|
12253
|
+
// authentication BearerAuth required
|
|
12254
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
12255
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
12256
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
12257
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12258
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12259
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(order, localVarRequestOptions, configuration);
|
|
12260
|
+
return {
|
|
12261
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
12262
|
+
options: localVarRequestOptions,
|
|
12263
|
+
};
|
|
12264
|
+
}),
|
|
12265
|
+
/**
|
|
12266
|
+
* Returns list of all active credit plans for purchase
|
|
12267
|
+
* @summary Get available credit plans
|
|
12268
|
+
* @param {*} [options] Override http request option.
|
|
12269
|
+
* @throws {RequiredError}
|
|
12270
|
+
*/
|
|
12271
|
+
paymentGatewayCreditPlansGet: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
12272
|
+
const localVarPath = `/payment-gateway/credit-plans`;
|
|
12273
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12274
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
12275
|
+
let baseOptions;
|
|
12276
|
+
if (configuration) {
|
|
12277
|
+
baseOptions = configuration.baseOptions;
|
|
12278
|
+
}
|
|
12279
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
12280
|
+
const localVarHeaderParameter = {};
|
|
12281
|
+
const localVarQueryParameter = {};
|
|
12282
|
+
// authentication BearerAuth required
|
|
12283
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
12284
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
12285
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12286
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12287
|
+
return {
|
|
12288
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
12289
|
+
options: localVarRequestOptions,
|
|
12290
|
+
};
|
|
12291
|
+
}),
|
|
12292
|
+
/**
|
|
12293
|
+
* Returns list of all available payment gateways
|
|
12294
|
+
* @summary Get available payment gateways
|
|
12295
|
+
* @param {*} [options] Override http request option.
|
|
12296
|
+
* @throws {RequiredError}
|
|
12297
|
+
*/
|
|
12298
|
+
paymentGatewayGatewaysGet: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
12299
|
+
const localVarPath = `/payment-gateway/gateways`;
|
|
12300
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12301
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
12302
|
+
let baseOptions;
|
|
12303
|
+
if (configuration) {
|
|
12304
|
+
baseOptions = configuration.baseOptions;
|
|
12305
|
+
}
|
|
12306
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
12307
|
+
const localVarHeaderParameter = {};
|
|
12308
|
+
const localVarQueryParameter = {};
|
|
12309
|
+
// authentication BearerAuth required
|
|
12310
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
12311
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
12312
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12313
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12314
|
+
return {
|
|
12315
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
12316
|
+
options: localVarRequestOptions,
|
|
12317
|
+
};
|
|
12318
|
+
}),
|
|
12319
|
+
/**
|
|
12320
|
+
* Processes a refund for a completed payment
|
|
12321
|
+
* @summary Process payment refund
|
|
12322
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
12323
|
+
* @param {*} [options] Override http request option.
|
|
12324
|
+
* @throws {RequiredError}
|
|
12325
|
+
*/
|
|
12326
|
+
paymentGatewayRefundPost: (refund_1, ...args_1) => __awaiter(this, [refund_1, ...args_1], void 0, function* (refund, options = {}) {
|
|
12327
|
+
// verify required parameter 'refund' is not null or undefined
|
|
12328
|
+
(0, common_1.assertParamExists)('paymentGatewayRefundPost', 'refund', refund);
|
|
12329
|
+
const localVarPath = `/payment-gateway/refund`;
|
|
12330
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12331
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
12332
|
+
let baseOptions;
|
|
12333
|
+
if (configuration) {
|
|
12334
|
+
baseOptions = configuration.baseOptions;
|
|
12335
|
+
}
|
|
12336
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
12337
|
+
const localVarHeaderParameter = {};
|
|
12338
|
+
const localVarQueryParameter = {};
|
|
12339
|
+
// authentication BearerAuth required
|
|
12340
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
12341
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
12342
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
12343
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12344
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12345
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(refund, localVarRequestOptions, configuration);
|
|
12346
|
+
return {
|
|
12347
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
12348
|
+
options: localVarRequestOptions,
|
|
12349
|
+
};
|
|
12350
|
+
}),
|
|
12351
|
+
/**
|
|
12352
|
+
* Verifies the current status of a payment
|
|
12353
|
+
* @summary Verify payment status
|
|
12354
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
12355
|
+
* @param {*} [options] Override http request option.
|
|
12356
|
+
* @throws {RequiredError}
|
|
12357
|
+
*/
|
|
12358
|
+
paymentGatewayVerifyPost: (verify_1, ...args_1) => __awaiter(this, [verify_1, ...args_1], void 0, function* (verify, options = {}) {
|
|
12359
|
+
// verify required parameter 'verify' is not null or undefined
|
|
12360
|
+
(0, common_1.assertParamExists)('paymentGatewayVerifyPost', 'verify', verify);
|
|
12361
|
+
const localVarPath = `/payment-gateway/verify`;
|
|
12362
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12363
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
12364
|
+
let baseOptions;
|
|
12365
|
+
if (configuration) {
|
|
12366
|
+
baseOptions = configuration.baseOptions;
|
|
12367
|
+
}
|
|
12368
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
12369
|
+
const localVarHeaderParameter = {};
|
|
12370
|
+
const localVarQueryParameter = {};
|
|
12371
|
+
// authentication BearerAuth required
|
|
12372
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
12373
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
12374
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
12375
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12376
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12377
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(verify, localVarRequestOptions, configuration);
|
|
12378
|
+
return {
|
|
12379
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
12380
|
+
options: localVarRequestOptions,
|
|
12381
|
+
};
|
|
12382
|
+
}),
|
|
12383
|
+
};
|
|
12384
|
+
};
|
|
12385
|
+
exports.PaymentGatewayApiAxiosParamCreator = PaymentGatewayApiAxiosParamCreator;
|
|
12386
|
+
/**
|
|
12387
|
+
* PaymentGatewayApi - functional programming interface
|
|
12388
|
+
* @export
|
|
12389
|
+
*/
|
|
12390
|
+
const PaymentGatewayApiFp = function (configuration) {
|
|
12391
|
+
const localVarAxiosParamCreator = (0, exports.PaymentGatewayApiAxiosParamCreator)(configuration);
|
|
12392
|
+
return {
|
|
12393
|
+
/**
|
|
12394
|
+
* Creates a payment order using specified or default payment gateway
|
|
12395
|
+
* @summary Create a new payment order
|
|
12396
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
12397
|
+
* @param {*} [options] Override http request option.
|
|
12398
|
+
* @throws {RequiredError}
|
|
12399
|
+
*/
|
|
12400
|
+
paymentGatewayCreateOrderPost(order, options) {
|
|
12401
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12402
|
+
var _a, _b, _c;
|
|
12403
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayCreateOrderPost(order, options);
|
|
12404
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12405
|
+
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;
|
|
12406
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12407
|
+
});
|
|
12408
|
+
},
|
|
12409
|
+
/**
|
|
12410
|
+
* Returns list of all active credit plans for purchase
|
|
12411
|
+
* @summary Get available credit plans
|
|
12412
|
+
* @param {*} [options] Override http request option.
|
|
12413
|
+
* @throws {RequiredError}
|
|
12414
|
+
*/
|
|
12415
|
+
paymentGatewayCreditPlansGet(options) {
|
|
12416
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12417
|
+
var _a, _b, _c;
|
|
12418
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayCreditPlansGet(options);
|
|
12419
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12420
|
+
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;
|
|
12421
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12422
|
+
});
|
|
12423
|
+
},
|
|
12424
|
+
/**
|
|
12425
|
+
* Returns list of all available payment gateways
|
|
12426
|
+
* @summary Get available payment gateways
|
|
12427
|
+
* @param {*} [options] Override http request option.
|
|
12428
|
+
* @throws {RequiredError}
|
|
12429
|
+
*/
|
|
12430
|
+
paymentGatewayGatewaysGet(options) {
|
|
12431
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12432
|
+
var _a, _b, _c;
|
|
12433
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayGatewaysGet(options);
|
|
12434
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12435
|
+
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;
|
|
12436
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12437
|
+
});
|
|
12438
|
+
},
|
|
12439
|
+
/**
|
|
12440
|
+
* Processes a refund for a completed payment
|
|
12441
|
+
* @summary Process payment refund
|
|
12442
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
12443
|
+
* @param {*} [options] Override http request option.
|
|
12444
|
+
* @throws {RequiredError}
|
|
12445
|
+
*/
|
|
12446
|
+
paymentGatewayRefundPost(refund, options) {
|
|
12447
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12448
|
+
var _a, _b, _c;
|
|
12449
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayRefundPost(refund, options);
|
|
12450
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12451
|
+
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;
|
|
12452
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12453
|
+
});
|
|
12454
|
+
},
|
|
12455
|
+
/**
|
|
12456
|
+
* Verifies the current status of a payment
|
|
12457
|
+
* @summary Verify payment status
|
|
12458
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
12459
|
+
* @param {*} [options] Override http request option.
|
|
12460
|
+
* @throws {RequiredError}
|
|
12461
|
+
*/
|
|
12462
|
+
paymentGatewayVerifyPost(verify, options) {
|
|
12463
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12464
|
+
var _a, _b, _c;
|
|
12465
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayVerifyPost(verify, options);
|
|
12466
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12467
|
+
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;
|
|
12468
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12469
|
+
});
|
|
12470
|
+
},
|
|
12471
|
+
};
|
|
12472
|
+
};
|
|
12473
|
+
exports.PaymentGatewayApiFp = PaymentGatewayApiFp;
|
|
12474
|
+
/**
|
|
12475
|
+
* PaymentGatewayApi - factory interface
|
|
12476
|
+
* @export
|
|
12477
|
+
*/
|
|
12478
|
+
const PaymentGatewayApiFactory = function (configuration, basePath, axios) {
|
|
12479
|
+
const localVarFp = (0, exports.PaymentGatewayApiFp)(configuration);
|
|
12480
|
+
return {
|
|
12481
|
+
/**
|
|
12482
|
+
* Creates a payment order using specified or default payment gateway
|
|
12483
|
+
* @summary Create a new payment order
|
|
12484
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
12485
|
+
* @param {*} [options] Override http request option.
|
|
12486
|
+
* @throws {RequiredError}
|
|
12487
|
+
*/
|
|
12488
|
+
paymentGatewayCreateOrderPost(order, options) {
|
|
12489
|
+
return localVarFp.paymentGatewayCreateOrderPost(order, options).then((request) => request(axios, basePath));
|
|
12490
|
+
},
|
|
12491
|
+
/**
|
|
12492
|
+
* Returns list of all active credit plans for purchase
|
|
12493
|
+
* @summary Get available credit plans
|
|
12494
|
+
* @param {*} [options] Override http request option.
|
|
12495
|
+
* @throws {RequiredError}
|
|
12496
|
+
*/
|
|
12497
|
+
paymentGatewayCreditPlansGet(options) {
|
|
12498
|
+
return localVarFp.paymentGatewayCreditPlansGet(options).then((request) => request(axios, basePath));
|
|
12499
|
+
},
|
|
12500
|
+
/**
|
|
12501
|
+
* Returns list of all available payment gateways
|
|
12502
|
+
* @summary Get available payment gateways
|
|
12503
|
+
* @param {*} [options] Override http request option.
|
|
12504
|
+
* @throws {RequiredError}
|
|
12505
|
+
*/
|
|
12506
|
+
paymentGatewayGatewaysGet(options) {
|
|
12507
|
+
return localVarFp.paymentGatewayGatewaysGet(options).then((request) => request(axios, basePath));
|
|
12508
|
+
},
|
|
12509
|
+
/**
|
|
12510
|
+
* Processes a refund for a completed payment
|
|
12511
|
+
* @summary Process payment refund
|
|
12512
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
12513
|
+
* @param {*} [options] Override http request option.
|
|
12514
|
+
* @throws {RequiredError}
|
|
12515
|
+
*/
|
|
12516
|
+
paymentGatewayRefundPost(refund, options) {
|
|
12517
|
+
return localVarFp.paymentGatewayRefundPost(refund, options).then((request) => request(axios, basePath));
|
|
12518
|
+
},
|
|
12519
|
+
/**
|
|
12520
|
+
* Verifies the current status of a payment
|
|
12521
|
+
* @summary Verify payment status
|
|
12522
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
12523
|
+
* @param {*} [options] Override http request option.
|
|
12524
|
+
* @throws {RequiredError}
|
|
12525
|
+
*/
|
|
12526
|
+
paymentGatewayVerifyPost(verify, options) {
|
|
12527
|
+
return localVarFp.paymentGatewayVerifyPost(verify, options).then((request) => request(axios, basePath));
|
|
12528
|
+
},
|
|
12529
|
+
};
|
|
12530
|
+
};
|
|
12531
|
+
exports.PaymentGatewayApiFactory = PaymentGatewayApiFactory;
|
|
12532
|
+
/**
|
|
12533
|
+
* PaymentGatewayApi - object-oriented interface
|
|
12534
|
+
* @export
|
|
12535
|
+
* @class PaymentGatewayApi
|
|
12536
|
+
* @extends {BaseAPI}
|
|
12537
|
+
*/
|
|
12538
|
+
class PaymentGatewayApi extends base_1.BaseAPI {
|
|
12539
|
+
/**
|
|
12540
|
+
* Creates a payment order using specified or default payment gateway
|
|
12541
|
+
* @summary Create a new payment order
|
|
12542
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
12543
|
+
* @param {*} [options] Override http request option.
|
|
12544
|
+
* @throws {RequiredError}
|
|
12545
|
+
* @memberof PaymentGatewayApi
|
|
12546
|
+
*/
|
|
12547
|
+
paymentGatewayCreateOrderPost(order, options) {
|
|
12548
|
+
return (0, exports.PaymentGatewayApiFp)(this.configuration).paymentGatewayCreateOrderPost(order, options).then((request) => request(this.axios, this.basePath));
|
|
12549
|
+
}
|
|
12550
|
+
/**
|
|
12551
|
+
* Returns list of all active credit plans for purchase
|
|
12552
|
+
* @summary Get available credit plans
|
|
12553
|
+
* @param {*} [options] Override http request option.
|
|
12554
|
+
* @throws {RequiredError}
|
|
12555
|
+
* @memberof PaymentGatewayApi
|
|
12556
|
+
*/
|
|
12557
|
+
paymentGatewayCreditPlansGet(options) {
|
|
12558
|
+
return (0, exports.PaymentGatewayApiFp)(this.configuration).paymentGatewayCreditPlansGet(options).then((request) => request(this.axios, this.basePath));
|
|
12559
|
+
}
|
|
12560
|
+
/**
|
|
12561
|
+
* Returns list of all available payment gateways
|
|
12562
|
+
* @summary Get available payment gateways
|
|
12563
|
+
* @param {*} [options] Override http request option.
|
|
12564
|
+
* @throws {RequiredError}
|
|
12565
|
+
* @memberof PaymentGatewayApi
|
|
12566
|
+
*/
|
|
12567
|
+
paymentGatewayGatewaysGet(options) {
|
|
12568
|
+
return (0, exports.PaymentGatewayApiFp)(this.configuration).paymentGatewayGatewaysGet(options).then((request) => request(this.axios, this.basePath));
|
|
12569
|
+
}
|
|
12570
|
+
/**
|
|
12571
|
+
* Processes a refund for a completed payment
|
|
12572
|
+
* @summary Process payment refund
|
|
12573
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
12574
|
+
* @param {*} [options] Override http request option.
|
|
12575
|
+
* @throws {RequiredError}
|
|
12576
|
+
* @memberof PaymentGatewayApi
|
|
12577
|
+
*/
|
|
12578
|
+
paymentGatewayRefundPost(refund, options) {
|
|
12579
|
+
return (0, exports.PaymentGatewayApiFp)(this.configuration).paymentGatewayRefundPost(refund, options).then((request) => request(this.axios, this.basePath));
|
|
12580
|
+
}
|
|
12581
|
+
/**
|
|
12582
|
+
* Verifies the current status of a payment
|
|
12583
|
+
* @summary Verify payment status
|
|
12584
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
12585
|
+
* @param {*} [options] Override http request option.
|
|
12586
|
+
* @throws {RequiredError}
|
|
12587
|
+
* @memberof PaymentGatewayApi
|
|
12588
|
+
*/
|
|
12589
|
+
paymentGatewayVerifyPost(verify, options) {
|
|
12590
|
+
return (0, exports.PaymentGatewayApiFp)(this.configuration).paymentGatewayVerifyPost(verify, options).then((request) => request(this.axios, this.basePath));
|
|
12591
|
+
}
|
|
12592
|
+
}
|
|
12593
|
+
exports.PaymentGatewayApi = PaymentGatewayApi;
|
|
12033
12594
|
/**
|
|
12034
12595
|
* PaymentsApi - axios parameter creator
|
|
12035
12596
|
* @export
|