@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/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
|
}
|
|
@@ -1991,12 +2036,25 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1991
2036
|
};
|
|
1992
2037
|
}),
|
|
1993
2038
|
/**
|
|
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.
|
|
2039
|
+
* 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
2040
|
* @summary Get Top Results Analytics
|
|
1996
2041
|
* @param {string} xStoreID Store ID
|
|
1997
2042
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
1998
2043
|
* @param {string} [endTime] End time in RFC3339 format
|
|
1999
2044
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
2045
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2046
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2047
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2048
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2049
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2050
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2051
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2052
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2053
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2054
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2055
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2056
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2057
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2000
2058
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
2001
2059
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
2002
2060
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
@@ -2010,7 +2068,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2010
2068
|
* @param {*} [options] Override http request option.
|
|
2011
2069
|
* @throws {RequiredError}
|
|
2012
2070
|
*/
|
|
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 = {}) {
|
|
2071
|
+
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
2072
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
2015
2073
|
assertParamExists('adminAnalyticsStoreXStoreIDResultsGet', 'xStoreID', xStoreID);
|
|
2016
2074
|
const localVarPath = `/admin/analytics/store/{xStoreID}/results`
|
|
@@ -2035,6 +2093,45 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2035
2093
|
if (itemIds !== undefined) {
|
|
2036
2094
|
localVarQueryParameter['item_ids'] = itemIds;
|
|
2037
2095
|
}
|
|
2096
|
+
if (analyticsTags !== undefined) {
|
|
2097
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
2098
|
+
}
|
|
2099
|
+
if (tagsMatchMode !== undefined) {
|
|
2100
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
2101
|
+
}
|
|
2102
|
+
if (tagsExclude !== undefined) {
|
|
2103
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
2104
|
+
}
|
|
2105
|
+
if (tagKeyFilter !== undefined) {
|
|
2106
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
2107
|
+
}
|
|
2108
|
+
if (tagValueFilter !== undefined) {
|
|
2109
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
2110
|
+
}
|
|
2111
|
+
if (compareMode !== undefined) {
|
|
2112
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
2113
|
+
}
|
|
2114
|
+
if (compareStartTime !== undefined) {
|
|
2115
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
2116
|
+
}
|
|
2117
|
+
if (compareEndTime !== undefined) {
|
|
2118
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
2119
|
+
}
|
|
2120
|
+
if (compareAnalyticsTags !== undefined) {
|
|
2121
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
2122
|
+
}
|
|
2123
|
+
if (compareTagsMatchMode !== undefined) {
|
|
2124
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
2125
|
+
}
|
|
2126
|
+
if (compareTagsExclude !== undefined) {
|
|
2127
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
2128
|
+
}
|
|
2129
|
+
if (compareTagKeyFilter !== undefined) {
|
|
2130
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
2131
|
+
}
|
|
2132
|
+
if (compareTagValueFilter !== undefined) {
|
|
2133
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
2134
|
+
}
|
|
2038
2135
|
if (minImpressions !== undefined) {
|
|
2039
2136
|
localVarQueryParameter['min_impressions'] = minImpressions;
|
|
2040
2137
|
}
|
|
@@ -2518,12 +2615,17 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2518
2615
|
});
|
|
2519
2616
|
},
|
|
2520
2617
|
/**
|
|
2521
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
2618
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
2522
2619
|
* @summary Get No-Clicks Queries
|
|
2523
2620
|
* @param {string} xStoreID Store ID
|
|
2524
2621
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2525
2622
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2526
2623
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
2624
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2625
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2626
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2627
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2628
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2527
2629
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2528
2630
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2529
2631
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -2542,22 +2644,27 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2542
2644
|
* @param {*} [options] Override http request option.
|
|
2543
2645
|
* @throws {RequiredError}
|
|
2544
2646
|
*/
|
|
2545
|
-
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2647
|
+
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
2648
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2547
2649
|
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);
|
|
2650
|
+
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
2651
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2550
2652
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesNoClicksGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2551
2653
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2552
2654
|
});
|
|
2553
2655
|
},
|
|
2554
2656
|
/**
|
|
2555
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
2657
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
2556
2658
|
* @summary Get No-Results Queries
|
|
2557
2659
|
* @param {string} xStoreID Store ID
|
|
2558
2660
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2559
2661
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2560
2662
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
2663
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2664
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2665
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2666
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2667
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2561
2668
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2562
2669
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2563
2670
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -2576,10 +2683,10 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2576
2683
|
* @param {*} [options] Override http request option.
|
|
2577
2684
|
* @throws {RequiredError}
|
|
2578
2685
|
*/
|
|
2579
|
-
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2686
|
+
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
2687
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2581
2688
|
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);
|
|
2689
|
+
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
2690
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2584
2691
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesNoResultsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2585
2692
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2605,12 +2712,25 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2605
2712
|
});
|
|
2606
2713
|
},
|
|
2607
2714
|
/**
|
|
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.
|
|
2715
|
+
* 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
2716
|
* @summary Get Top Results Analytics
|
|
2610
2717
|
* @param {string} xStoreID Store ID
|
|
2611
2718
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2612
2719
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2613
2720
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
2721
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2722
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2723
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2724
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2725
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2726
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2727
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2728
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2729
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2730
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2731
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2732
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2733
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2614
2734
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
2615
2735
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
2616
2736
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
@@ -2624,10 +2744,10 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2624
2744
|
* @param {*} [options] Override http request option.
|
|
2625
2745
|
* @throws {RequiredError}
|
|
2626
2746
|
*/
|
|
2627
|
-
adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options) {
|
|
2747
|
+
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
2748
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2629
2749
|
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);
|
|
2750
|
+
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
2751
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2632
2752
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDResultsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2633
2753
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2920,12 +3040,17 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2920
3040
|
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
3041
|
},
|
|
2922
3042
|
/**
|
|
2923
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
3043
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
2924
3044
|
* @summary Get No-Clicks Queries
|
|
2925
3045
|
* @param {string} xStoreID Store ID
|
|
2926
3046
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2927
3047
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2928
3048
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
3049
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3050
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3051
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3052
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3053
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2929
3054
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2930
3055
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2931
3056
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -2944,16 +3069,21 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2944
3069
|
* @param {*} [options] Override http request option.
|
|
2945
3070
|
* @throws {RequiredError}
|
|
2946
3071
|
*/
|
|
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));
|
|
3072
|
+
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) {
|
|
3073
|
+
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
3074
|
},
|
|
2950
3075
|
/**
|
|
2951
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
3076
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
2952
3077
|
* @summary Get No-Results Queries
|
|
2953
3078
|
* @param {string} xStoreID Store ID
|
|
2954
3079
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2955
3080
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2956
3081
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
3082
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3083
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3084
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3085
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3086
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2957
3087
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2958
3088
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2959
3089
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -2972,8 +3102,8 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2972
3102
|
* @param {*} [options] Override http request option.
|
|
2973
3103
|
* @throws {RequiredError}
|
|
2974
3104
|
*/
|
|
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));
|
|
3105
|
+
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) {
|
|
3106
|
+
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
3107
|
},
|
|
2978
3108
|
/**
|
|
2979
3109
|
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
@@ -2989,12 +3119,25 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2989
3119
|
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options).then((request) => request(axios, basePath));
|
|
2990
3120
|
},
|
|
2991
3121
|
/**
|
|
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.
|
|
3122
|
+
* 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
3123
|
* @summary Get Top Results Analytics
|
|
2994
3124
|
* @param {string} xStoreID Store ID
|
|
2995
3125
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2996
3126
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2997
3127
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
3128
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3129
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3130
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3131
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3132
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3133
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3134
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3135
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3136
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3137
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3138
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3139
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3140
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2998
3141
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
2999
3142
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
3000
3143
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
@@ -3008,8 +3151,8 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
3008
3151
|
* @param {*} [options] Override http request option.
|
|
3009
3152
|
* @throws {RequiredError}
|
|
3010
3153
|
*/
|
|
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));
|
|
3154
|
+
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) {
|
|
3155
|
+
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
3156
|
},
|
|
3014
3157
|
/**
|
|
3015
3158
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
@@ -3297,12 +3440,17 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3297
3440
|
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
3441
|
}
|
|
3299
3442
|
/**
|
|
3300
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
3443
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
3301
3444
|
* @summary Get No-Clicks Queries
|
|
3302
3445
|
* @param {string} xStoreID Store ID
|
|
3303
3446
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3304
3447
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3305
3448
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
3449
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3450
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3451
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3452
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3453
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3306
3454
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3307
3455
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3308
3456
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -3322,16 +3470,21 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3322
3470
|
* @throws {RequiredError}
|
|
3323
3471
|
* @memberof AnalyticsApi
|
|
3324
3472
|
*/
|
|
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));
|
|
3473
|
+
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) {
|
|
3474
|
+
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
3475
|
}
|
|
3328
3476
|
/**
|
|
3329
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
3477
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
3330
3478
|
* @summary Get No-Results Queries
|
|
3331
3479
|
* @param {string} xStoreID Store ID
|
|
3332
3480
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3333
3481
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3334
3482
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
3483
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3484
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3485
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3486
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3487
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3335
3488
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3336
3489
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3337
3490
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -3351,8 +3504,8 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3351
3504
|
* @throws {RequiredError}
|
|
3352
3505
|
* @memberof AnalyticsApi
|
|
3353
3506
|
*/
|
|
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));
|
|
3507
|
+
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) {
|
|
3508
|
+
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
3509
|
}
|
|
3357
3510
|
/**
|
|
3358
3511
|
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
@@ -3369,12 +3522,25 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3369
3522
|
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options).then((request) => request(this.axios, this.basePath));
|
|
3370
3523
|
}
|
|
3371
3524
|
/**
|
|
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.
|
|
3525
|
+
* 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
3526
|
* @summary Get Top Results Analytics
|
|
3374
3527
|
* @param {string} xStoreID Store ID
|
|
3375
3528
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3376
3529
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3377
3530
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
3531
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3532
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3533
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3534
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3535
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3536
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3537
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3538
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3539
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3540
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3541
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3542
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3543
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3378
3544
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
3379
3545
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
3380
3546
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
@@ -3389,8 +3555,8 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3389
3555
|
* @throws {RequiredError}
|
|
3390
3556
|
* @memberof AnalyticsApi
|
|
3391
3557
|
*/
|
|
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));
|
|
3558
|
+
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) {
|
|
3559
|
+
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
3560
|
}
|
|
3395
3561
|
/**
|
|
3396
3562
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
@@ -3637,6 +3803,13 @@ export const AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum = {
|
|
|
3637
3803
|
Asc: 'asc',
|
|
3638
3804
|
Desc: 'desc'
|
|
3639
3805
|
};
|
|
3806
|
+
/**
|
|
3807
|
+
* @export
|
|
3808
|
+
*/
|
|
3809
|
+
export const AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum = {
|
|
3810
|
+
Any: 'any',
|
|
3811
|
+
All: 'all'
|
|
3812
|
+
};
|
|
3640
3813
|
/**
|
|
3641
3814
|
* @export
|
|
3642
3815
|
*/
|
|
@@ -3659,6 +3832,13 @@ export const AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum = {
|
|
|
3659
3832
|
Asc: 'asc',
|
|
3660
3833
|
Desc: 'desc'
|
|
3661
3834
|
};
|
|
3835
|
+
/**
|
|
3836
|
+
* @export
|
|
3837
|
+
*/
|
|
3838
|
+
export const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum = {
|
|
3839
|
+
Any: 'any',
|
|
3840
|
+
All: 'all'
|
|
3841
|
+
};
|
|
3662
3842
|
/**
|
|
3663
3843
|
* @export
|
|
3664
3844
|
*/
|
|
@@ -3681,6 +3861,20 @@ export const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = {
|
|
|
3681
3861
|
Asc: 'asc',
|
|
3682
3862
|
Desc: 'desc'
|
|
3683
3863
|
};
|
|
3864
|
+
/**
|
|
3865
|
+
* @export
|
|
3866
|
+
*/
|
|
3867
|
+
export const AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum = {
|
|
3868
|
+
Any: 'any',
|
|
3869
|
+
All: 'all'
|
|
3870
|
+
};
|
|
3871
|
+
/**
|
|
3872
|
+
* @export
|
|
3873
|
+
*/
|
|
3874
|
+
export const AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum = {
|
|
3875
|
+
Any: 'any',
|
|
3876
|
+
All: 'all'
|
|
3877
|
+
};
|
|
3684
3878
|
/**
|
|
3685
3879
|
* @export
|
|
3686
3880
|
*/
|
|
@@ -11948,6 +12142,369 @@ export class ParentMenusApi extends BaseAPI {
|
|
|
11948
12142
|
return ParentMenusApiFp(this.configuration).miscParentMenusPost(parentMenu, options).then((request) => request(this.axios, this.basePath));
|
|
11949
12143
|
}
|
|
11950
12144
|
}
|
|
12145
|
+
/**
|
|
12146
|
+
* PaymentGatewayApi - axios parameter creator
|
|
12147
|
+
* @export
|
|
12148
|
+
*/
|
|
12149
|
+
export const PaymentGatewayApiAxiosParamCreator = function (configuration) {
|
|
12150
|
+
return {
|
|
12151
|
+
/**
|
|
12152
|
+
* Creates a payment order using specified or default payment gateway
|
|
12153
|
+
* @summary Create a new payment order
|
|
12154
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
12155
|
+
* @param {*} [options] Override http request option.
|
|
12156
|
+
* @throws {RequiredError}
|
|
12157
|
+
*/
|
|
12158
|
+
paymentGatewayCreateOrderPost: (order_1, ...args_1) => __awaiter(this, [order_1, ...args_1], void 0, function* (order, options = {}) {
|
|
12159
|
+
// verify required parameter 'order' is not null or undefined
|
|
12160
|
+
assertParamExists('paymentGatewayCreateOrderPost', 'order', order);
|
|
12161
|
+
const localVarPath = `/payment-gateway/create-order`;
|
|
12162
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12163
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12164
|
+
let baseOptions;
|
|
12165
|
+
if (configuration) {
|
|
12166
|
+
baseOptions = configuration.baseOptions;
|
|
12167
|
+
}
|
|
12168
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
12169
|
+
const localVarHeaderParameter = {};
|
|
12170
|
+
const localVarQueryParameter = {};
|
|
12171
|
+
// authentication BearerAuth required
|
|
12172
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
12173
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
12174
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12175
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12176
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12177
|
+
localVarRequestOptions.data = serializeDataIfNeeded(order, localVarRequestOptions, configuration);
|
|
12178
|
+
return {
|
|
12179
|
+
url: toPathString(localVarUrlObj),
|
|
12180
|
+
options: localVarRequestOptions,
|
|
12181
|
+
};
|
|
12182
|
+
}),
|
|
12183
|
+
/**
|
|
12184
|
+
* Returns list of all active credit plans for purchase
|
|
12185
|
+
* @summary Get available credit plans
|
|
12186
|
+
* @param {*} [options] Override http request option.
|
|
12187
|
+
* @throws {RequiredError}
|
|
12188
|
+
*/
|
|
12189
|
+
paymentGatewayCreditPlansGet: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
12190
|
+
const localVarPath = `/payment-gateway/credit-plans`;
|
|
12191
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12192
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12193
|
+
let baseOptions;
|
|
12194
|
+
if (configuration) {
|
|
12195
|
+
baseOptions = configuration.baseOptions;
|
|
12196
|
+
}
|
|
12197
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
12198
|
+
const localVarHeaderParameter = {};
|
|
12199
|
+
const localVarQueryParameter = {};
|
|
12200
|
+
// authentication BearerAuth required
|
|
12201
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
12202
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12203
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12204
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12205
|
+
return {
|
|
12206
|
+
url: toPathString(localVarUrlObj),
|
|
12207
|
+
options: localVarRequestOptions,
|
|
12208
|
+
};
|
|
12209
|
+
}),
|
|
12210
|
+
/**
|
|
12211
|
+
* Returns list of all available payment gateways
|
|
12212
|
+
* @summary Get available payment gateways
|
|
12213
|
+
* @param {*} [options] Override http request option.
|
|
12214
|
+
* @throws {RequiredError}
|
|
12215
|
+
*/
|
|
12216
|
+
paymentGatewayGatewaysGet: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
12217
|
+
const localVarPath = `/payment-gateway/gateways`;
|
|
12218
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12219
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12220
|
+
let baseOptions;
|
|
12221
|
+
if (configuration) {
|
|
12222
|
+
baseOptions = configuration.baseOptions;
|
|
12223
|
+
}
|
|
12224
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
12225
|
+
const localVarHeaderParameter = {};
|
|
12226
|
+
const localVarQueryParameter = {};
|
|
12227
|
+
// authentication BearerAuth required
|
|
12228
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
12229
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12230
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12231
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12232
|
+
return {
|
|
12233
|
+
url: toPathString(localVarUrlObj),
|
|
12234
|
+
options: localVarRequestOptions,
|
|
12235
|
+
};
|
|
12236
|
+
}),
|
|
12237
|
+
/**
|
|
12238
|
+
* Processes a refund for a completed payment
|
|
12239
|
+
* @summary Process payment refund
|
|
12240
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
12241
|
+
* @param {*} [options] Override http request option.
|
|
12242
|
+
* @throws {RequiredError}
|
|
12243
|
+
*/
|
|
12244
|
+
paymentGatewayRefundPost: (refund_1, ...args_1) => __awaiter(this, [refund_1, ...args_1], void 0, function* (refund, options = {}) {
|
|
12245
|
+
// verify required parameter 'refund' is not null or undefined
|
|
12246
|
+
assertParamExists('paymentGatewayRefundPost', 'refund', refund);
|
|
12247
|
+
const localVarPath = `/payment-gateway/refund`;
|
|
12248
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12249
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12250
|
+
let baseOptions;
|
|
12251
|
+
if (configuration) {
|
|
12252
|
+
baseOptions = configuration.baseOptions;
|
|
12253
|
+
}
|
|
12254
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
12255
|
+
const localVarHeaderParameter = {};
|
|
12256
|
+
const localVarQueryParameter = {};
|
|
12257
|
+
// authentication BearerAuth required
|
|
12258
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
12259
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
12260
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12261
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12262
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12263
|
+
localVarRequestOptions.data = serializeDataIfNeeded(refund, localVarRequestOptions, configuration);
|
|
12264
|
+
return {
|
|
12265
|
+
url: toPathString(localVarUrlObj),
|
|
12266
|
+
options: localVarRequestOptions,
|
|
12267
|
+
};
|
|
12268
|
+
}),
|
|
12269
|
+
/**
|
|
12270
|
+
* Verifies the current status of a payment
|
|
12271
|
+
* @summary Verify payment status
|
|
12272
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
12273
|
+
* @param {*} [options] Override http request option.
|
|
12274
|
+
* @throws {RequiredError}
|
|
12275
|
+
*/
|
|
12276
|
+
paymentGatewayVerifyPost: (verify_1, ...args_1) => __awaiter(this, [verify_1, ...args_1], void 0, function* (verify, options = {}) {
|
|
12277
|
+
// verify required parameter 'verify' is not null or undefined
|
|
12278
|
+
assertParamExists('paymentGatewayVerifyPost', 'verify', verify);
|
|
12279
|
+
const localVarPath = `/payment-gateway/verify`;
|
|
12280
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12281
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12282
|
+
let baseOptions;
|
|
12283
|
+
if (configuration) {
|
|
12284
|
+
baseOptions = configuration.baseOptions;
|
|
12285
|
+
}
|
|
12286
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
12287
|
+
const localVarHeaderParameter = {};
|
|
12288
|
+
const localVarQueryParameter = {};
|
|
12289
|
+
// authentication BearerAuth required
|
|
12290
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
12291
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
12292
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12293
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12294
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12295
|
+
localVarRequestOptions.data = serializeDataIfNeeded(verify, localVarRequestOptions, configuration);
|
|
12296
|
+
return {
|
|
12297
|
+
url: toPathString(localVarUrlObj),
|
|
12298
|
+
options: localVarRequestOptions,
|
|
12299
|
+
};
|
|
12300
|
+
}),
|
|
12301
|
+
};
|
|
12302
|
+
};
|
|
12303
|
+
/**
|
|
12304
|
+
* PaymentGatewayApi - functional programming interface
|
|
12305
|
+
* @export
|
|
12306
|
+
*/
|
|
12307
|
+
export const PaymentGatewayApiFp = function (configuration) {
|
|
12308
|
+
const localVarAxiosParamCreator = PaymentGatewayApiAxiosParamCreator(configuration);
|
|
12309
|
+
return {
|
|
12310
|
+
/**
|
|
12311
|
+
* Creates a payment order using specified or default payment gateway
|
|
12312
|
+
* @summary Create a new payment order
|
|
12313
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
12314
|
+
* @param {*} [options] Override http request option.
|
|
12315
|
+
* @throws {RequiredError}
|
|
12316
|
+
*/
|
|
12317
|
+
paymentGatewayCreateOrderPost(order, options) {
|
|
12318
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12319
|
+
var _a, _b, _c;
|
|
12320
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayCreateOrderPost(order, options);
|
|
12321
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12322
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PaymentGatewayApi.paymentGatewayCreateOrderPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12323
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12324
|
+
});
|
|
12325
|
+
},
|
|
12326
|
+
/**
|
|
12327
|
+
* Returns list of all active credit plans for purchase
|
|
12328
|
+
* @summary Get available credit plans
|
|
12329
|
+
* @param {*} [options] Override http request option.
|
|
12330
|
+
* @throws {RequiredError}
|
|
12331
|
+
*/
|
|
12332
|
+
paymentGatewayCreditPlansGet(options) {
|
|
12333
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12334
|
+
var _a, _b, _c;
|
|
12335
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayCreditPlansGet(options);
|
|
12336
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12337
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PaymentGatewayApi.paymentGatewayCreditPlansGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12338
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12339
|
+
});
|
|
12340
|
+
},
|
|
12341
|
+
/**
|
|
12342
|
+
* Returns list of all available payment gateways
|
|
12343
|
+
* @summary Get available payment gateways
|
|
12344
|
+
* @param {*} [options] Override http request option.
|
|
12345
|
+
* @throws {RequiredError}
|
|
12346
|
+
*/
|
|
12347
|
+
paymentGatewayGatewaysGet(options) {
|
|
12348
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12349
|
+
var _a, _b, _c;
|
|
12350
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayGatewaysGet(options);
|
|
12351
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12352
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PaymentGatewayApi.paymentGatewayGatewaysGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12353
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12354
|
+
});
|
|
12355
|
+
},
|
|
12356
|
+
/**
|
|
12357
|
+
* Processes a refund for a completed payment
|
|
12358
|
+
* @summary Process payment refund
|
|
12359
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
12360
|
+
* @param {*} [options] Override http request option.
|
|
12361
|
+
* @throws {RequiredError}
|
|
12362
|
+
*/
|
|
12363
|
+
paymentGatewayRefundPost(refund, options) {
|
|
12364
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12365
|
+
var _a, _b, _c;
|
|
12366
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayRefundPost(refund, options);
|
|
12367
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12368
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PaymentGatewayApi.paymentGatewayRefundPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12369
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12370
|
+
});
|
|
12371
|
+
},
|
|
12372
|
+
/**
|
|
12373
|
+
* Verifies the current status of a payment
|
|
12374
|
+
* @summary Verify payment status
|
|
12375
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
12376
|
+
* @param {*} [options] Override http request option.
|
|
12377
|
+
* @throws {RequiredError}
|
|
12378
|
+
*/
|
|
12379
|
+
paymentGatewayVerifyPost(verify, options) {
|
|
12380
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12381
|
+
var _a, _b, _c;
|
|
12382
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayVerifyPost(verify, options);
|
|
12383
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12384
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PaymentGatewayApi.paymentGatewayVerifyPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12385
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12386
|
+
});
|
|
12387
|
+
},
|
|
12388
|
+
};
|
|
12389
|
+
};
|
|
12390
|
+
/**
|
|
12391
|
+
* PaymentGatewayApi - factory interface
|
|
12392
|
+
* @export
|
|
12393
|
+
*/
|
|
12394
|
+
export const PaymentGatewayApiFactory = function (configuration, basePath, axios) {
|
|
12395
|
+
const localVarFp = PaymentGatewayApiFp(configuration);
|
|
12396
|
+
return {
|
|
12397
|
+
/**
|
|
12398
|
+
* Creates a payment order using specified or default payment gateway
|
|
12399
|
+
* @summary Create a new payment order
|
|
12400
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
12401
|
+
* @param {*} [options] Override http request option.
|
|
12402
|
+
* @throws {RequiredError}
|
|
12403
|
+
*/
|
|
12404
|
+
paymentGatewayCreateOrderPost(order, options) {
|
|
12405
|
+
return localVarFp.paymentGatewayCreateOrderPost(order, options).then((request) => request(axios, basePath));
|
|
12406
|
+
},
|
|
12407
|
+
/**
|
|
12408
|
+
* Returns list of all active credit plans for purchase
|
|
12409
|
+
* @summary Get available credit plans
|
|
12410
|
+
* @param {*} [options] Override http request option.
|
|
12411
|
+
* @throws {RequiredError}
|
|
12412
|
+
*/
|
|
12413
|
+
paymentGatewayCreditPlansGet(options) {
|
|
12414
|
+
return localVarFp.paymentGatewayCreditPlansGet(options).then((request) => request(axios, basePath));
|
|
12415
|
+
},
|
|
12416
|
+
/**
|
|
12417
|
+
* Returns list of all available payment gateways
|
|
12418
|
+
* @summary Get available payment gateways
|
|
12419
|
+
* @param {*} [options] Override http request option.
|
|
12420
|
+
* @throws {RequiredError}
|
|
12421
|
+
*/
|
|
12422
|
+
paymentGatewayGatewaysGet(options) {
|
|
12423
|
+
return localVarFp.paymentGatewayGatewaysGet(options).then((request) => request(axios, basePath));
|
|
12424
|
+
},
|
|
12425
|
+
/**
|
|
12426
|
+
* Processes a refund for a completed payment
|
|
12427
|
+
* @summary Process payment refund
|
|
12428
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
12429
|
+
* @param {*} [options] Override http request option.
|
|
12430
|
+
* @throws {RequiredError}
|
|
12431
|
+
*/
|
|
12432
|
+
paymentGatewayRefundPost(refund, options) {
|
|
12433
|
+
return localVarFp.paymentGatewayRefundPost(refund, options).then((request) => request(axios, basePath));
|
|
12434
|
+
},
|
|
12435
|
+
/**
|
|
12436
|
+
* Verifies the current status of a payment
|
|
12437
|
+
* @summary Verify payment status
|
|
12438
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
12439
|
+
* @param {*} [options] Override http request option.
|
|
12440
|
+
* @throws {RequiredError}
|
|
12441
|
+
*/
|
|
12442
|
+
paymentGatewayVerifyPost(verify, options) {
|
|
12443
|
+
return localVarFp.paymentGatewayVerifyPost(verify, options).then((request) => request(axios, basePath));
|
|
12444
|
+
},
|
|
12445
|
+
};
|
|
12446
|
+
};
|
|
12447
|
+
/**
|
|
12448
|
+
* PaymentGatewayApi - object-oriented interface
|
|
12449
|
+
* @export
|
|
12450
|
+
* @class PaymentGatewayApi
|
|
12451
|
+
* @extends {BaseAPI}
|
|
12452
|
+
*/
|
|
12453
|
+
export class PaymentGatewayApi extends BaseAPI {
|
|
12454
|
+
/**
|
|
12455
|
+
* Creates a payment order using specified or default payment gateway
|
|
12456
|
+
* @summary Create a new payment order
|
|
12457
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
12458
|
+
* @param {*} [options] Override http request option.
|
|
12459
|
+
* @throws {RequiredError}
|
|
12460
|
+
* @memberof PaymentGatewayApi
|
|
12461
|
+
*/
|
|
12462
|
+
paymentGatewayCreateOrderPost(order, options) {
|
|
12463
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayCreateOrderPost(order, options).then((request) => request(this.axios, this.basePath));
|
|
12464
|
+
}
|
|
12465
|
+
/**
|
|
12466
|
+
* Returns list of all active credit plans for purchase
|
|
12467
|
+
* @summary Get available credit plans
|
|
12468
|
+
* @param {*} [options] Override http request option.
|
|
12469
|
+
* @throws {RequiredError}
|
|
12470
|
+
* @memberof PaymentGatewayApi
|
|
12471
|
+
*/
|
|
12472
|
+
paymentGatewayCreditPlansGet(options) {
|
|
12473
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayCreditPlansGet(options).then((request) => request(this.axios, this.basePath));
|
|
12474
|
+
}
|
|
12475
|
+
/**
|
|
12476
|
+
* Returns list of all available payment gateways
|
|
12477
|
+
* @summary Get available payment gateways
|
|
12478
|
+
* @param {*} [options] Override http request option.
|
|
12479
|
+
* @throws {RequiredError}
|
|
12480
|
+
* @memberof PaymentGatewayApi
|
|
12481
|
+
*/
|
|
12482
|
+
paymentGatewayGatewaysGet(options) {
|
|
12483
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayGatewaysGet(options).then((request) => request(this.axios, this.basePath));
|
|
12484
|
+
}
|
|
12485
|
+
/**
|
|
12486
|
+
* Processes a refund for a completed payment
|
|
12487
|
+
* @summary Process payment refund
|
|
12488
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
12489
|
+
* @param {*} [options] Override http request option.
|
|
12490
|
+
* @throws {RequiredError}
|
|
12491
|
+
* @memberof PaymentGatewayApi
|
|
12492
|
+
*/
|
|
12493
|
+
paymentGatewayRefundPost(refund, options) {
|
|
12494
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayRefundPost(refund, options).then((request) => request(this.axios, this.basePath));
|
|
12495
|
+
}
|
|
12496
|
+
/**
|
|
12497
|
+
* Verifies the current status of a payment
|
|
12498
|
+
* @summary Verify payment status
|
|
12499
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
12500
|
+
* @param {*} [options] Override http request option.
|
|
12501
|
+
* @throws {RequiredError}
|
|
12502
|
+
* @memberof PaymentGatewayApi
|
|
12503
|
+
*/
|
|
12504
|
+
paymentGatewayVerifyPost(verify, options) {
|
|
12505
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayVerifyPost(verify, options).then((request) => request(this.axios, this.basePath));
|
|
12506
|
+
}
|
|
12507
|
+
}
|
|
11951
12508
|
/**
|
|
11952
12509
|
* PaymentsApi - axios parameter creator
|
|
11953
12510
|
* @export
|