@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/esm/api.js
CHANGED
|
@@ -30,6 +30,11 @@ export const DataTypesCreateCustomWordListRequestTypeEnum = {
|
|
|
30
30
|
Stopwords: 'stopwords',
|
|
31
31
|
Synonyms: 'synonyms'
|
|
32
32
|
};
|
|
33
|
+
export const DataTypesCreatePaymentOrderRequestPaymentTypeEnum = {
|
|
34
|
+
Generic: 'generic',
|
|
35
|
+
Subscription: 'subscription',
|
|
36
|
+
CreditTopup: 'credit_topup'
|
|
37
|
+
};
|
|
33
38
|
export const DataTypesCreatePluralDeclensionRequestTypeEnum = {
|
|
34
39
|
Custom: 'custom',
|
|
35
40
|
Default: 'default'
|
|
@@ -1742,12 +1747,17 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1742
1747
|
};
|
|
1743
1748
|
}),
|
|
1744
1749
|
/**
|
|
1745
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
1750
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
1746
1751
|
* @summary Get No-Clicks Queries
|
|
1747
1752
|
* @param {string} xStoreID Store ID
|
|
1748
1753
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
1749
1754
|
* @param {string} [endTime] End time in RFC3339 format
|
|
1750
1755
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
1756
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
1757
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
1758
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
1759
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
1760
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
1751
1761
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
1752
1762
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
1753
1763
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -1766,7 +1776,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1766
1776
|
* @param {*} [options] Override http request option.
|
|
1767
1777
|
* @throws {RequiredError}
|
|
1768
1778
|
*/
|
|
1769
|
-
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 = {}) {
|
|
1779
|
+
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 = {}) {
|
|
1770
1780
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
1771
1781
|
assertParamExists('adminAnalyticsStoreXStoreIDQueriesNoClicksGet', 'xStoreID', xStoreID);
|
|
1772
1782
|
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/no-clicks`
|
|
@@ -1791,6 +1801,21 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1791
1801
|
if (search !== undefined) {
|
|
1792
1802
|
localVarQueryParameter['search'] = search;
|
|
1793
1803
|
}
|
|
1804
|
+
if (analyticsTags !== undefined) {
|
|
1805
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
1806
|
+
}
|
|
1807
|
+
if (tagsMatchMode !== undefined) {
|
|
1808
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
1809
|
+
}
|
|
1810
|
+
if (tagsExclude !== undefined) {
|
|
1811
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
1812
|
+
}
|
|
1813
|
+
if (tagKeyFilter !== undefined) {
|
|
1814
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
1815
|
+
}
|
|
1816
|
+
if (tagValueFilter !== undefined) {
|
|
1817
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
1818
|
+
}
|
|
1794
1819
|
if (compareMode !== undefined) {
|
|
1795
1820
|
localVarQueryParameter['compare_mode'] = compareMode;
|
|
1796
1821
|
}
|
|
@@ -1845,12 +1870,17 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1845
1870
|
};
|
|
1846
1871
|
}),
|
|
1847
1872
|
/**
|
|
1848
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
1873
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
1849
1874
|
* @summary Get No-Results Queries
|
|
1850
1875
|
* @param {string} xStoreID Store ID
|
|
1851
1876
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
1852
1877
|
* @param {string} [endTime] End time in RFC3339 format
|
|
1853
1878
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
1879
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
1880
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
1881
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
1882
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
1883
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
1854
1884
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
1855
1885
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
1856
1886
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -1869,7 +1899,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1869
1899
|
* @param {*} [options] Override http request option.
|
|
1870
1900
|
* @throws {RequiredError}
|
|
1871
1901
|
*/
|
|
1872
|
-
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 = {}) {
|
|
1902
|
+
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 = {}) {
|
|
1873
1903
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
1874
1904
|
assertParamExists('adminAnalyticsStoreXStoreIDQueriesNoResultsGet', 'xStoreID', xStoreID);
|
|
1875
1905
|
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/no-results`
|
|
@@ -1894,6 +1924,21 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1894
1924
|
if (search !== undefined) {
|
|
1895
1925
|
localVarQueryParameter['search'] = search;
|
|
1896
1926
|
}
|
|
1927
|
+
if (analyticsTags !== undefined) {
|
|
1928
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
1929
|
+
}
|
|
1930
|
+
if (tagsMatchMode !== undefined) {
|
|
1931
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
1932
|
+
}
|
|
1933
|
+
if (tagsExclude !== undefined) {
|
|
1934
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
1935
|
+
}
|
|
1936
|
+
if (tagKeyFilter !== undefined) {
|
|
1937
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
1938
|
+
}
|
|
1939
|
+
if (tagValueFilter !== undefined) {
|
|
1940
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
1941
|
+
}
|
|
1897
1942
|
if (compareMode !== undefined) {
|
|
1898
1943
|
localVarQueryParameter['compare_mode'] = compareMode;
|
|
1899
1944
|
}
|
|
@@ -1948,16 +1993,21 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1948
1993
|
};
|
|
1949
1994
|
}),
|
|
1950
1995
|
/**
|
|
1951
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
1996
|
+
* 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
|
|
1952
1997
|
* @summary Get Query Insights
|
|
1953
1998
|
* @param {string} xStoreID Store ID
|
|
1954
1999
|
* @param {string} query Search query to analyze
|
|
1955
2000
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
1956
2001
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2002
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
2003
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
2004
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
2005
|
+
* @param {number} [filtersPageSize] Number of filters per page for popular filters
|
|
2006
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
1957
2007
|
* @param {*} [options] Override http request option.
|
|
1958
2008
|
* @throws {RequiredError}
|
|
1959
2009
|
*/
|
|
1960
|
-
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 = {}) {
|
|
2010
|
+
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 = {}) {
|
|
1961
2011
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
1962
2012
|
assertParamExists('adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet', 'xStoreID', xStoreID);
|
|
1963
2013
|
// verify required parameter 'query' is not null or undefined
|
|
@@ -1982,6 +2032,21 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1982
2032
|
if (endTime !== undefined) {
|
|
1983
2033
|
localVarQueryParameter['end_time'] = endTime;
|
|
1984
2034
|
}
|
|
2035
|
+
if (resultsPage !== undefined) {
|
|
2036
|
+
localVarQueryParameter['results_page'] = resultsPage;
|
|
2037
|
+
}
|
|
2038
|
+
if (resultsPageSize !== undefined) {
|
|
2039
|
+
localVarQueryParameter['results_page_size'] = resultsPageSize;
|
|
2040
|
+
}
|
|
2041
|
+
if (filtersPage !== undefined) {
|
|
2042
|
+
localVarQueryParameter['filters_page'] = filtersPage;
|
|
2043
|
+
}
|
|
2044
|
+
if (filtersPageSize !== undefined) {
|
|
2045
|
+
localVarQueryParameter['filters_page_size'] = filtersPageSize;
|
|
2046
|
+
}
|
|
2047
|
+
if (includeWidget !== undefined) {
|
|
2048
|
+
localVarQueryParameter['include_widget'] = includeWidget;
|
|
2049
|
+
}
|
|
1985
2050
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1986
2051
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1987
2052
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -1991,12 +2056,25 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1991
2056
|
};
|
|
1992
2057
|
}),
|
|
1993
2058
|
/**
|
|
1994
|
-
* 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.
|
|
2059
|
+
* 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.
|
|
1995
2060
|
* @summary Get Top Results Analytics
|
|
1996
2061
|
* @param {string} xStoreID Store ID
|
|
1997
2062
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
1998
2063
|
* @param {string} [endTime] End time in RFC3339 format
|
|
1999
2064
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
2065
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2066
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2067
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2068
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2069
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2070
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2071
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2072
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2073
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2074
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2075
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2076
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2077
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2000
2078
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
2001
2079
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
2002
2080
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
@@ -2010,7 +2088,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2010
2088
|
* @param {*} [options] Override http request option.
|
|
2011
2089
|
* @throws {RequiredError}
|
|
2012
2090
|
*/
|
|
2013
|
-
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 = {}) {
|
|
2091
|
+
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 = {}) {
|
|
2014
2092
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
2015
2093
|
assertParamExists('adminAnalyticsStoreXStoreIDResultsGet', 'xStoreID', xStoreID);
|
|
2016
2094
|
const localVarPath = `/admin/analytics/store/{xStoreID}/results`
|
|
@@ -2035,6 +2113,45 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2035
2113
|
if (itemIds !== undefined) {
|
|
2036
2114
|
localVarQueryParameter['item_ids'] = itemIds;
|
|
2037
2115
|
}
|
|
2116
|
+
if (analyticsTags !== undefined) {
|
|
2117
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
2118
|
+
}
|
|
2119
|
+
if (tagsMatchMode !== undefined) {
|
|
2120
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
2121
|
+
}
|
|
2122
|
+
if (tagsExclude !== undefined) {
|
|
2123
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
2124
|
+
}
|
|
2125
|
+
if (tagKeyFilter !== undefined) {
|
|
2126
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
2127
|
+
}
|
|
2128
|
+
if (tagValueFilter !== undefined) {
|
|
2129
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
2130
|
+
}
|
|
2131
|
+
if (compareMode !== undefined) {
|
|
2132
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
2133
|
+
}
|
|
2134
|
+
if (compareStartTime !== undefined) {
|
|
2135
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
2136
|
+
}
|
|
2137
|
+
if (compareEndTime !== undefined) {
|
|
2138
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
2139
|
+
}
|
|
2140
|
+
if (compareAnalyticsTags !== undefined) {
|
|
2141
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
2142
|
+
}
|
|
2143
|
+
if (compareTagsMatchMode !== undefined) {
|
|
2144
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
2145
|
+
}
|
|
2146
|
+
if (compareTagsExclude !== undefined) {
|
|
2147
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
2148
|
+
}
|
|
2149
|
+
if (compareTagKeyFilter !== undefined) {
|
|
2150
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
2151
|
+
}
|
|
2152
|
+
if (compareTagValueFilter !== undefined) {
|
|
2153
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
2154
|
+
}
|
|
2038
2155
|
if (minImpressions !== undefined) {
|
|
2039
2156
|
localVarQueryParameter['min_impressions'] = minImpressions;
|
|
2040
2157
|
}
|
|
@@ -2518,12 +2635,17 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2518
2635
|
});
|
|
2519
2636
|
},
|
|
2520
2637
|
/**
|
|
2521
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
2638
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
2522
2639
|
* @summary Get No-Clicks Queries
|
|
2523
2640
|
* @param {string} xStoreID Store ID
|
|
2524
2641
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2525
2642
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2526
2643
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
2644
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2645
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2646
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2647
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2648
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2527
2649
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2528
2650
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2529
2651
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -2542,22 +2664,27 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2542
2664
|
* @param {*} [options] Override http request option.
|
|
2543
2665
|
* @throws {RequiredError}
|
|
2544
2666
|
*/
|
|
2545
|
-
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2667
|
+
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) {
|
|
2546
2668
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2547
2669
|
var _a, _b, _c;
|
|
2548
|
-
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);
|
|
2670
|
+
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);
|
|
2549
2671
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2550
2672
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesNoClicksGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2551
2673
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2552
2674
|
});
|
|
2553
2675
|
},
|
|
2554
2676
|
/**
|
|
2555
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
2677
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
2556
2678
|
* @summary Get No-Results Queries
|
|
2557
2679
|
* @param {string} xStoreID Store ID
|
|
2558
2680
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2559
2681
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2560
2682
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
2683
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2684
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2685
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2686
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2687
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2561
2688
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2562
2689
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2563
2690
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -2576,41 +2703,59 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2576
2703
|
* @param {*} [options] Override http request option.
|
|
2577
2704
|
* @throws {RequiredError}
|
|
2578
2705
|
*/
|
|
2579
|
-
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2706
|
+
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) {
|
|
2580
2707
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2581
2708
|
var _a, _b, _c;
|
|
2582
|
-
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);
|
|
2709
|
+
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);
|
|
2583
2710
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2584
2711
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesNoResultsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2585
2712
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2586
2713
|
});
|
|
2587
2714
|
},
|
|
2588
2715
|
/**
|
|
2589
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
2716
|
+
* 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
|
|
2590
2717
|
* @summary Get Query Insights
|
|
2591
2718
|
* @param {string} xStoreID Store ID
|
|
2592
2719
|
* @param {string} query Search query to analyze
|
|
2593
2720
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2594
2721
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2722
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
2723
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
2724
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
2725
|
+
* @param {number} [filtersPageSize] Number of filters per page for popular filters
|
|
2726
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
2595
2727
|
* @param {*} [options] Override http request option.
|
|
2596
2728
|
* @throws {RequiredError}
|
|
2597
2729
|
*/
|
|
2598
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options) {
|
|
2730
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
|
|
2599
2731
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2600
2732
|
var _a, _b, _c;
|
|
2601
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options);
|
|
2733
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options);
|
|
2602
2734
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2603
2735
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2604
2736
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2605
2737
|
});
|
|
2606
2738
|
},
|
|
2607
2739
|
/**
|
|
2608
|
-
* 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.
|
|
2740
|
+
* 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.
|
|
2609
2741
|
* @summary Get Top Results Analytics
|
|
2610
2742
|
* @param {string} xStoreID Store ID
|
|
2611
2743
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2612
2744
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2613
2745
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
2746
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2747
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2748
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2749
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2750
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2751
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2752
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2753
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2754
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2755
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2756
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2757
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2758
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2614
2759
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
2615
2760
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
2616
2761
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
@@ -2624,10 +2769,10 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2624
2769
|
* @param {*} [options] Override http request option.
|
|
2625
2770
|
* @throws {RequiredError}
|
|
2626
2771
|
*/
|
|
2627
|
-
adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options) {
|
|
2772
|
+
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) {
|
|
2628
2773
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2629
2774
|
var _a, _b, _c;
|
|
2630
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options);
|
|
2775
|
+
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);
|
|
2631
2776
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2632
2777
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDResultsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2633
2778
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2920,12 +3065,17 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2920
3065
|
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));
|
|
2921
3066
|
},
|
|
2922
3067
|
/**
|
|
2923
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
3068
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
2924
3069
|
* @summary Get No-Clicks Queries
|
|
2925
3070
|
* @param {string} xStoreID Store ID
|
|
2926
3071
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2927
3072
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2928
3073
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
3074
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3075
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3076
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3077
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3078
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2929
3079
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2930
3080
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2931
3081
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -2944,16 +3094,21 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2944
3094
|
* @param {*} [options] Override http request option.
|
|
2945
3095
|
* @throws {RequiredError}
|
|
2946
3096
|
*/
|
|
2947
|
-
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2948
|
-
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));
|
|
3097
|
+
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) {
|
|
3098
|
+
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));
|
|
2949
3099
|
},
|
|
2950
3100
|
/**
|
|
2951
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
3101
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
2952
3102
|
* @summary Get No-Results Queries
|
|
2953
3103
|
* @param {string} xStoreID Store ID
|
|
2954
3104
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2955
3105
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2956
3106
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
3107
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3108
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3109
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3110
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3111
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2957
3112
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2958
3113
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2959
3114
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -2972,29 +3127,47 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2972
3127
|
* @param {*} [options] Override http request option.
|
|
2973
3128
|
* @throws {RequiredError}
|
|
2974
3129
|
*/
|
|
2975
|
-
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2976
|
-
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));
|
|
3130
|
+
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) {
|
|
3131
|
+
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));
|
|
2977
3132
|
},
|
|
2978
3133
|
/**
|
|
2979
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
3134
|
+
* 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
|
|
2980
3135
|
* @summary Get Query Insights
|
|
2981
3136
|
* @param {string} xStoreID Store ID
|
|
2982
3137
|
* @param {string} query Search query to analyze
|
|
2983
3138
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2984
3139
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3140
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
3141
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
3142
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
3143
|
+
* @param {number} [filtersPageSize] Number of filters per page for popular filters
|
|
3144
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
2985
3145
|
* @param {*} [options] Override http request option.
|
|
2986
3146
|
* @throws {RequiredError}
|
|
2987
3147
|
*/
|
|
2988
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options) {
|
|
2989
|
-
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options).then((request) => request(axios, basePath));
|
|
3148
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
|
|
3149
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(axios, basePath));
|
|
2990
3150
|
},
|
|
2991
3151
|
/**
|
|
2992
|
-
* 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.
|
|
3152
|
+
* 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.
|
|
2993
3153
|
* @summary Get Top Results Analytics
|
|
2994
3154
|
* @param {string} xStoreID Store ID
|
|
2995
3155
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2996
3156
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2997
3157
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
3158
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3159
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3160
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3161
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3162
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3163
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3164
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3165
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3166
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3167
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3168
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3169
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3170
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2998
3171
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
2999
3172
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
3000
3173
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
@@ -3008,8 +3181,8 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
3008
3181
|
* @param {*} [options] Override http request option.
|
|
3009
3182
|
* @throws {RequiredError}
|
|
3010
3183
|
*/
|
|
3011
|
-
adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options) {
|
|
3012
|
-
return localVarFp.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options).then((request) => request(axios, basePath));
|
|
3184
|
+
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) {
|
|
3185
|
+
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));
|
|
3013
3186
|
},
|
|
3014
3187
|
/**
|
|
3015
3188
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
@@ -3297,12 +3470,17 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3297
3470
|
return 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));
|
|
3298
3471
|
}
|
|
3299
3472
|
/**
|
|
3300
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
3473
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
3301
3474
|
* @summary Get No-Clicks Queries
|
|
3302
3475
|
* @param {string} xStoreID Store ID
|
|
3303
3476
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3304
3477
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3305
3478
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
3479
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3480
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3481
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3482
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3483
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3306
3484
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3307
3485
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3308
3486
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -3322,16 +3500,21 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3322
3500
|
* @throws {RequiredError}
|
|
3323
3501
|
* @memberof AnalyticsApi
|
|
3324
3502
|
*/
|
|
3325
|
-
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
3326
|
-
return 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));
|
|
3503
|
+
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) {
|
|
3504
|
+
return 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));
|
|
3327
3505
|
}
|
|
3328
3506
|
/**
|
|
3329
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
3507
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
3330
3508
|
* @summary Get No-Results Queries
|
|
3331
3509
|
* @param {string} xStoreID Store ID
|
|
3332
3510
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3333
3511
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3334
3512
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
3513
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3514
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3515
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3516
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3517
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3335
3518
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3336
3519
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3337
3520
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -3351,30 +3534,48 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3351
3534
|
* @throws {RequiredError}
|
|
3352
3535
|
* @memberof AnalyticsApi
|
|
3353
3536
|
*/
|
|
3354
|
-
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
3355
|
-
return 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));
|
|
3537
|
+
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) {
|
|
3538
|
+
return 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));
|
|
3356
3539
|
}
|
|
3357
3540
|
/**
|
|
3358
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
3541
|
+
* 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
|
|
3359
3542
|
* @summary Get Query Insights
|
|
3360
3543
|
* @param {string} xStoreID Store ID
|
|
3361
3544
|
* @param {string} query Search query to analyze
|
|
3362
3545
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3363
3546
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3547
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
3548
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
3549
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
3550
|
+
* @param {number} [filtersPageSize] Number of filters per page for popular filters
|
|
3551
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
3364
3552
|
* @param {*} [options] Override http request option.
|
|
3365
3553
|
* @throws {RequiredError}
|
|
3366
3554
|
* @memberof AnalyticsApi
|
|
3367
3555
|
*/
|
|
3368
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options) {
|
|
3369
|
-
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options).then((request) => request(this.axios, this.basePath));
|
|
3556
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
|
|
3557
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(this.axios, this.basePath));
|
|
3370
3558
|
}
|
|
3371
3559
|
/**
|
|
3372
|
-
* 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.
|
|
3560
|
+
* 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.
|
|
3373
3561
|
* @summary Get Top Results Analytics
|
|
3374
3562
|
* @param {string} xStoreID Store ID
|
|
3375
3563
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3376
3564
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3377
3565
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
3566
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3567
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3568
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3569
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3570
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3571
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3572
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3573
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3574
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3575
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3576
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3577
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3578
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3378
3579
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
3379
3580
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
3380
3581
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
@@ -3389,8 +3590,8 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3389
3590
|
* @throws {RequiredError}
|
|
3390
3591
|
* @memberof AnalyticsApi
|
|
3391
3592
|
*/
|
|
3392
|
-
adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options) {
|
|
3393
|
-
return 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));
|
|
3593
|
+
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) {
|
|
3594
|
+
return 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));
|
|
3394
3595
|
}
|
|
3395
3596
|
/**
|
|
3396
3597
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
@@ -3637,6 +3838,13 @@ export const AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum = {
|
|
|
3637
3838
|
Asc: 'asc',
|
|
3638
3839
|
Desc: 'desc'
|
|
3639
3840
|
};
|
|
3841
|
+
/**
|
|
3842
|
+
* @export
|
|
3843
|
+
*/
|
|
3844
|
+
export const AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum = {
|
|
3845
|
+
Any: 'any',
|
|
3846
|
+
All: 'all'
|
|
3847
|
+
};
|
|
3640
3848
|
/**
|
|
3641
3849
|
* @export
|
|
3642
3850
|
*/
|
|
@@ -3659,6 +3867,13 @@ export const AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum = {
|
|
|
3659
3867
|
Asc: 'asc',
|
|
3660
3868
|
Desc: 'desc'
|
|
3661
3869
|
};
|
|
3870
|
+
/**
|
|
3871
|
+
* @export
|
|
3872
|
+
*/
|
|
3873
|
+
export const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum = {
|
|
3874
|
+
Any: 'any',
|
|
3875
|
+
All: 'all'
|
|
3876
|
+
};
|
|
3662
3877
|
/**
|
|
3663
3878
|
* @export
|
|
3664
3879
|
*/
|
|
@@ -3681,6 +3896,20 @@ export const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = {
|
|
|
3681
3896
|
Asc: 'asc',
|
|
3682
3897
|
Desc: 'desc'
|
|
3683
3898
|
};
|
|
3899
|
+
/**
|
|
3900
|
+
* @export
|
|
3901
|
+
*/
|
|
3902
|
+
export const AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum = {
|
|
3903
|
+
Any: 'any',
|
|
3904
|
+
All: 'all'
|
|
3905
|
+
};
|
|
3906
|
+
/**
|
|
3907
|
+
* @export
|
|
3908
|
+
*/
|
|
3909
|
+
export const AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum = {
|
|
3910
|
+
Any: 'any',
|
|
3911
|
+
All: 'all'
|
|
3912
|
+
};
|
|
3684
3913
|
/**
|
|
3685
3914
|
* @export
|
|
3686
3915
|
*/
|
|
@@ -11948,6 +12177,369 @@ export class ParentMenusApi extends BaseAPI {
|
|
|
11948
12177
|
return ParentMenusApiFp(this.configuration).miscParentMenusPost(parentMenu, options).then((request) => request(this.axios, this.basePath));
|
|
11949
12178
|
}
|
|
11950
12179
|
}
|
|
12180
|
+
/**
|
|
12181
|
+
* PaymentGatewayApi - axios parameter creator
|
|
12182
|
+
* @export
|
|
12183
|
+
*/
|
|
12184
|
+
export const PaymentGatewayApiAxiosParamCreator = function (configuration) {
|
|
12185
|
+
return {
|
|
12186
|
+
/**
|
|
12187
|
+
* Creates a payment order using specified or default payment gateway
|
|
12188
|
+
* @summary Create a new payment order
|
|
12189
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
12190
|
+
* @param {*} [options] Override http request option.
|
|
12191
|
+
* @throws {RequiredError}
|
|
12192
|
+
*/
|
|
12193
|
+
paymentGatewayCreateOrderPost: (order_1, ...args_1) => __awaiter(this, [order_1, ...args_1], void 0, function* (order, options = {}) {
|
|
12194
|
+
// verify required parameter 'order' is not null or undefined
|
|
12195
|
+
assertParamExists('paymentGatewayCreateOrderPost', 'order', order);
|
|
12196
|
+
const localVarPath = `/payment-gateway/create-order`;
|
|
12197
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12198
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12199
|
+
let baseOptions;
|
|
12200
|
+
if (configuration) {
|
|
12201
|
+
baseOptions = configuration.baseOptions;
|
|
12202
|
+
}
|
|
12203
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
12204
|
+
const localVarHeaderParameter = {};
|
|
12205
|
+
const localVarQueryParameter = {};
|
|
12206
|
+
// authentication BearerAuth required
|
|
12207
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
12208
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
12209
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12210
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12211
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12212
|
+
localVarRequestOptions.data = serializeDataIfNeeded(order, localVarRequestOptions, configuration);
|
|
12213
|
+
return {
|
|
12214
|
+
url: toPathString(localVarUrlObj),
|
|
12215
|
+
options: localVarRequestOptions,
|
|
12216
|
+
};
|
|
12217
|
+
}),
|
|
12218
|
+
/**
|
|
12219
|
+
* Returns list of all active credit plans for purchase
|
|
12220
|
+
* @summary Get available credit plans
|
|
12221
|
+
* @param {*} [options] Override http request option.
|
|
12222
|
+
* @throws {RequiredError}
|
|
12223
|
+
*/
|
|
12224
|
+
paymentGatewayCreditPlansGet: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
12225
|
+
const localVarPath = `/payment-gateway/credit-plans`;
|
|
12226
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12227
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12228
|
+
let baseOptions;
|
|
12229
|
+
if (configuration) {
|
|
12230
|
+
baseOptions = configuration.baseOptions;
|
|
12231
|
+
}
|
|
12232
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
12233
|
+
const localVarHeaderParameter = {};
|
|
12234
|
+
const localVarQueryParameter = {};
|
|
12235
|
+
// authentication BearerAuth required
|
|
12236
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
12237
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12238
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12239
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12240
|
+
return {
|
|
12241
|
+
url: toPathString(localVarUrlObj),
|
|
12242
|
+
options: localVarRequestOptions,
|
|
12243
|
+
};
|
|
12244
|
+
}),
|
|
12245
|
+
/**
|
|
12246
|
+
* Returns list of all available payment gateways
|
|
12247
|
+
* @summary Get available payment gateways
|
|
12248
|
+
* @param {*} [options] Override http request option.
|
|
12249
|
+
* @throws {RequiredError}
|
|
12250
|
+
*/
|
|
12251
|
+
paymentGatewayGatewaysGet: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
12252
|
+
const localVarPath = `/payment-gateway/gateways`;
|
|
12253
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12254
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12255
|
+
let baseOptions;
|
|
12256
|
+
if (configuration) {
|
|
12257
|
+
baseOptions = configuration.baseOptions;
|
|
12258
|
+
}
|
|
12259
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
12260
|
+
const localVarHeaderParameter = {};
|
|
12261
|
+
const localVarQueryParameter = {};
|
|
12262
|
+
// authentication BearerAuth required
|
|
12263
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
12264
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12265
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12266
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12267
|
+
return {
|
|
12268
|
+
url: toPathString(localVarUrlObj),
|
|
12269
|
+
options: localVarRequestOptions,
|
|
12270
|
+
};
|
|
12271
|
+
}),
|
|
12272
|
+
/**
|
|
12273
|
+
* Processes a refund for a completed payment
|
|
12274
|
+
* @summary Process payment refund
|
|
12275
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
12276
|
+
* @param {*} [options] Override http request option.
|
|
12277
|
+
* @throws {RequiredError}
|
|
12278
|
+
*/
|
|
12279
|
+
paymentGatewayRefundPost: (refund_1, ...args_1) => __awaiter(this, [refund_1, ...args_1], void 0, function* (refund, options = {}) {
|
|
12280
|
+
// verify required parameter 'refund' is not null or undefined
|
|
12281
|
+
assertParamExists('paymentGatewayRefundPost', 'refund', refund);
|
|
12282
|
+
const localVarPath = `/payment-gateway/refund`;
|
|
12283
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12284
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12285
|
+
let baseOptions;
|
|
12286
|
+
if (configuration) {
|
|
12287
|
+
baseOptions = configuration.baseOptions;
|
|
12288
|
+
}
|
|
12289
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
12290
|
+
const localVarHeaderParameter = {};
|
|
12291
|
+
const localVarQueryParameter = {};
|
|
12292
|
+
// authentication BearerAuth required
|
|
12293
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
12294
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
12295
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12296
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12297
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12298
|
+
localVarRequestOptions.data = serializeDataIfNeeded(refund, localVarRequestOptions, configuration);
|
|
12299
|
+
return {
|
|
12300
|
+
url: toPathString(localVarUrlObj),
|
|
12301
|
+
options: localVarRequestOptions,
|
|
12302
|
+
};
|
|
12303
|
+
}),
|
|
12304
|
+
/**
|
|
12305
|
+
* Verifies the current status of a payment
|
|
12306
|
+
* @summary Verify payment status
|
|
12307
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
12308
|
+
* @param {*} [options] Override http request option.
|
|
12309
|
+
* @throws {RequiredError}
|
|
12310
|
+
*/
|
|
12311
|
+
paymentGatewayVerifyPost: (verify_1, ...args_1) => __awaiter(this, [verify_1, ...args_1], void 0, function* (verify, options = {}) {
|
|
12312
|
+
// verify required parameter 'verify' is not null or undefined
|
|
12313
|
+
assertParamExists('paymentGatewayVerifyPost', 'verify', verify);
|
|
12314
|
+
const localVarPath = `/payment-gateway/verify`;
|
|
12315
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12316
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12317
|
+
let baseOptions;
|
|
12318
|
+
if (configuration) {
|
|
12319
|
+
baseOptions = configuration.baseOptions;
|
|
12320
|
+
}
|
|
12321
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
12322
|
+
const localVarHeaderParameter = {};
|
|
12323
|
+
const localVarQueryParameter = {};
|
|
12324
|
+
// authentication BearerAuth required
|
|
12325
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
12326
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
12327
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12328
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12329
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12330
|
+
localVarRequestOptions.data = serializeDataIfNeeded(verify, localVarRequestOptions, configuration);
|
|
12331
|
+
return {
|
|
12332
|
+
url: toPathString(localVarUrlObj),
|
|
12333
|
+
options: localVarRequestOptions,
|
|
12334
|
+
};
|
|
12335
|
+
}),
|
|
12336
|
+
};
|
|
12337
|
+
};
|
|
12338
|
+
/**
|
|
12339
|
+
* PaymentGatewayApi - functional programming interface
|
|
12340
|
+
* @export
|
|
12341
|
+
*/
|
|
12342
|
+
export const PaymentGatewayApiFp = function (configuration) {
|
|
12343
|
+
const localVarAxiosParamCreator = PaymentGatewayApiAxiosParamCreator(configuration);
|
|
12344
|
+
return {
|
|
12345
|
+
/**
|
|
12346
|
+
* Creates a payment order using specified or default payment gateway
|
|
12347
|
+
* @summary Create a new payment order
|
|
12348
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
12349
|
+
* @param {*} [options] Override http request option.
|
|
12350
|
+
* @throws {RequiredError}
|
|
12351
|
+
*/
|
|
12352
|
+
paymentGatewayCreateOrderPost(order, options) {
|
|
12353
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12354
|
+
var _a, _b, _c;
|
|
12355
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayCreateOrderPost(order, options);
|
|
12356
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12357
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PaymentGatewayApi.paymentGatewayCreateOrderPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12358
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12359
|
+
});
|
|
12360
|
+
},
|
|
12361
|
+
/**
|
|
12362
|
+
* Returns list of all active credit plans for purchase
|
|
12363
|
+
* @summary Get available credit plans
|
|
12364
|
+
* @param {*} [options] Override http request option.
|
|
12365
|
+
* @throws {RequiredError}
|
|
12366
|
+
*/
|
|
12367
|
+
paymentGatewayCreditPlansGet(options) {
|
|
12368
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12369
|
+
var _a, _b, _c;
|
|
12370
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayCreditPlansGet(options);
|
|
12371
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12372
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PaymentGatewayApi.paymentGatewayCreditPlansGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12373
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12374
|
+
});
|
|
12375
|
+
},
|
|
12376
|
+
/**
|
|
12377
|
+
* Returns list of all available payment gateways
|
|
12378
|
+
* @summary Get available payment gateways
|
|
12379
|
+
* @param {*} [options] Override http request option.
|
|
12380
|
+
* @throws {RequiredError}
|
|
12381
|
+
*/
|
|
12382
|
+
paymentGatewayGatewaysGet(options) {
|
|
12383
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12384
|
+
var _a, _b, _c;
|
|
12385
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayGatewaysGet(options);
|
|
12386
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12387
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PaymentGatewayApi.paymentGatewayGatewaysGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12388
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12389
|
+
});
|
|
12390
|
+
},
|
|
12391
|
+
/**
|
|
12392
|
+
* Processes a refund for a completed payment
|
|
12393
|
+
* @summary Process payment refund
|
|
12394
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
12395
|
+
* @param {*} [options] Override http request option.
|
|
12396
|
+
* @throws {RequiredError}
|
|
12397
|
+
*/
|
|
12398
|
+
paymentGatewayRefundPost(refund, options) {
|
|
12399
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12400
|
+
var _a, _b, _c;
|
|
12401
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayRefundPost(refund, options);
|
|
12402
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12403
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PaymentGatewayApi.paymentGatewayRefundPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12404
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12405
|
+
});
|
|
12406
|
+
},
|
|
12407
|
+
/**
|
|
12408
|
+
* Verifies the current status of a payment
|
|
12409
|
+
* @summary Verify payment status
|
|
12410
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
12411
|
+
* @param {*} [options] Override http request option.
|
|
12412
|
+
* @throws {RequiredError}
|
|
12413
|
+
*/
|
|
12414
|
+
paymentGatewayVerifyPost(verify, options) {
|
|
12415
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12416
|
+
var _a, _b, _c;
|
|
12417
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayVerifyPost(verify, options);
|
|
12418
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12419
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PaymentGatewayApi.paymentGatewayVerifyPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12420
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12421
|
+
});
|
|
12422
|
+
},
|
|
12423
|
+
};
|
|
12424
|
+
};
|
|
12425
|
+
/**
|
|
12426
|
+
* PaymentGatewayApi - factory interface
|
|
12427
|
+
* @export
|
|
12428
|
+
*/
|
|
12429
|
+
export const PaymentGatewayApiFactory = function (configuration, basePath, axios) {
|
|
12430
|
+
const localVarFp = PaymentGatewayApiFp(configuration);
|
|
12431
|
+
return {
|
|
12432
|
+
/**
|
|
12433
|
+
* Creates a payment order using specified or default payment gateway
|
|
12434
|
+
* @summary Create a new payment order
|
|
12435
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
12436
|
+
* @param {*} [options] Override http request option.
|
|
12437
|
+
* @throws {RequiredError}
|
|
12438
|
+
*/
|
|
12439
|
+
paymentGatewayCreateOrderPost(order, options) {
|
|
12440
|
+
return localVarFp.paymentGatewayCreateOrderPost(order, options).then((request) => request(axios, basePath));
|
|
12441
|
+
},
|
|
12442
|
+
/**
|
|
12443
|
+
* Returns list of all active credit plans for purchase
|
|
12444
|
+
* @summary Get available credit plans
|
|
12445
|
+
* @param {*} [options] Override http request option.
|
|
12446
|
+
* @throws {RequiredError}
|
|
12447
|
+
*/
|
|
12448
|
+
paymentGatewayCreditPlansGet(options) {
|
|
12449
|
+
return localVarFp.paymentGatewayCreditPlansGet(options).then((request) => request(axios, basePath));
|
|
12450
|
+
},
|
|
12451
|
+
/**
|
|
12452
|
+
* Returns list of all available payment gateways
|
|
12453
|
+
* @summary Get available payment gateways
|
|
12454
|
+
* @param {*} [options] Override http request option.
|
|
12455
|
+
* @throws {RequiredError}
|
|
12456
|
+
*/
|
|
12457
|
+
paymentGatewayGatewaysGet(options) {
|
|
12458
|
+
return localVarFp.paymentGatewayGatewaysGet(options).then((request) => request(axios, basePath));
|
|
12459
|
+
},
|
|
12460
|
+
/**
|
|
12461
|
+
* Processes a refund for a completed payment
|
|
12462
|
+
* @summary Process payment refund
|
|
12463
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
12464
|
+
* @param {*} [options] Override http request option.
|
|
12465
|
+
* @throws {RequiredError}
|
|
12466
|
+
*/
|
|
12467
|
+
paymentGatewayRefundPost(refund, options) {
|
|
12468
|
+
return localVarFp.paymentGatewayRefundPost(refund, options).then((request) => request(axios, basePath));
|
|
12469
|
+
},
|
|
12470
|
+
/**
|
|
12471
|
+
* Verifies the current status of a payment
|
|
12472
|
+
* @summary Verify payment status
|
|
12473
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
12474
|
+
* @param {*} [options] Override http request option.
|
|
12475
|
+
* @throws {RequiredError}
|
|
12476
|
+
*/
|
|
12477
|
+
paymentGatewayVerifyPost(verify, options) {
|
|
12478
|
+
return localVarFp.paymentGatewayVerifyPost(verify, options).then((request) => request(axios, basePath));
|
|
12479
|
+
},
|
|
12480
|
+
};
|
|
12481
|
+
};
|
|
12482
|
+
/**
|
|
12483
|
+
* PaymentGatewayApi - object-oriented interface
|
|
12484
|
+
* @export
|
|
12485
|
+
* @class PaymentGatewayApi
|
|
12486
|
+
* @extends {BaseAPI}
|
|
12487
|
+
*/
|
|
12488
|
+
export class PaymentGatewayApi extends BaseAPI {
|
|
12489
|
+
/**
|
|
12490
|
+
* Creates a payment order using specified or default payment gateway
|
|
12491
|
+
* @summary Create a new payment order
|
|
12492
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
12493
|
+
* @param {*} [options] Override http request option.
|
|
12494
|
+
* @throws {RequiredError}
|
|
12495
|
+
* @memberof PaymentGatewayApi
|
|
12496
|
+
*/
|
|
12497
|
+
paymentGatewayCreateOrderPost(order, options) {
|
|
12498
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayCreateOrderPost(order, options).then((request) => request(this.axios, this.basePath));
|
|
12499
|
+
}
|
|
12500
|
+
/**
|
|
12501
|
+
* Returns list of all active credit plans for purchase
|
|
12502
|
+
* @summary Get available credit plans
|
|
12503
|
+
* @param {*} [options] Override http request option.
|
|
12504
|
+
* @throws {RequiredError}
|
|
12505
|
+
* @memberof PaymentGatewayApi
|
|
12506
|
+
*/
|
|
12507
|
+
paymentGatewayCreditPlansGet(options) {
|
|
12508
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayCreditPlansGet(options).then((request) => request(this.axios, this.basePath));
|
|
12509
|
+
}
|
|
12510
|
+
/**
|
|
12511
|
+
* Returns list of all available payment gateways
|
|
12512
|
+
* @summary Get available payment gateways
|
|
12513
|
+
* @param {*} [options] Override http request option.
|
|
12514
|
+
* @throws {RequiredError}
|
|
12515
|
+
* @memberof PaymentGatewayApi
|
|
12516
|
+
*/
|
|
12517
|
+
paymentGatewayGatewaysGet(options) {
|
|
12518
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayGatewaysGet(options).then((request) => request(this.axios, this.basePath));
|
|
12519
|
+
}
|
|
12520
|
+
/**
|
|
12521
|
+
* Processes a refund for a completed payment
|
|
12522
|
+
* @summary Process payment refund
|
|
12523
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
12524
|
+
* @param {*} [options] Override http request option.
|
|
12525
|
+
* @throws {RequiredError}
|
|
12526
|
+
* @memberof PaymentGatewayApi
|
|
12527
|
+
*/
|
|
12528
|
+
paymentGatewayRefundPost(refund, options) {
|
|
12529
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayRefundPost(refund, options).then((request) => request(this.axios, this.basePath));
|
|
12530
|
+
}
|
|
12531
|
+
/**
|
|
12532
|
+
* Verifies the current status of a payment
|
|
12533
|
+
* @summary Verify payment status
|
|
12534
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
12535
|
+
* @param {*} [options] Override http request option.
|
|
12536
|
+
* @throws {RequiredError}
|
|
12537
|
+
* @memberof PaymentGatewayApi
|
|
12538
|
+
*/
|
|
12539
|
+
paymentGatewayVerifyPost(verify, options) {
|
|
12540
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayVerifyPost(verify, options).then((request) => request(this.axios, this.basePath));
|
|
12541
|
+
}
|
|
12542
|
+
}
|
|
11951
12543
|
/**
|
|
11952
12544
|
* PaymentsApi - axios parameter creator
|
|
11953
12545
|
* @export
|