@seekora-ai/admin-api 1.0.49 → 1.0.51
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 +73 -2
- package/api.ts +17186 -12372
- package/dist/api.d.ts +7067 -3338
- package/dist/api.js +2057 -51
- package/dist/esm/api.d.ts +7067 -3338
- package/dist/esm/api.js +2044 -47
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.0.51.tgz +0 -0
- package/seekora-ai-admin-api-1.0.49.tgz +0 -0
package/dist/api.js
CHANGED
|
@@ -22,16 +22,47 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.
|
|
26
|
-
exports.
|
|
27
|
-
exports.
|
|
28
|
-
exports.
|
|
25
|
+
exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDKpiGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDFiltersTrendsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDFiltersTrendsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDFiltersTrendsGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDFiltersGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDFiltersGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDFiltersGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDFiltersEffectivenessGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDFiltersEffectivenessGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDFiltersCombinationsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDFiltersCombinationsGetSortByEnum = exports.AnalyticsApi = exports.AnalyticsApiFactory = exports.AnalyticsApiFp = exports.AnalyticsApiAxiosParamCreator = exports.AccountSettingsApi = exports.AccountSettingsApiFactory = exports.AccountSettingsApiFp = exports.AccountSettingsApiAxiosParamCreator = exports.APICallsApi = exports.APICallsApiFactory = exports.APICallsApiFp = exports.APICallsApiAxiosParamCreator = exports.DataTypesUpdateWordStatusRequestWordTypeEnum = exports.DataTypesUpdatePluralDeclensionRequestTypeEnum = exports.DataTypesCreditTransactionTransactionTypeEnum = exports.DataTypesCreateTaskRequestTypeEnum = exports.DataTypesCreateTaskRequestIndexingStrategyEnum = exports.DataTypesCreateTaskRequestFrequencyEnum = exports.DataTypesCreatePluralDeclensionRequestTypeEnum = exports.DataTypesCreatePaymentOrderRequestPaymentTypeEnum = exports.DataTypesCreateCustomWordListRequestTypeEnum = exports.AnalyticsQuerySuggestionStatus = exports.AnalyticsQuerySuggestionSource = exports.AnalyticsBulkOperation = void 0;
|
|
26
|
+
exports.AdminAnalyticsStoreXStoreIDItemsDiscoveryGetSortByEnum = exports.ItemAnalyticsApi = exports.ItemAnalyticsApiFactory = exports.ItemAnalyticsApiFp = exports.ItemAnalyticsApiAxiosParamCreator = exports.DocumentsApi = exports.DocumentsApiFactory = exports.DocumentsApiFp = exports.DocumentsApiAxiosParamCreator = exports.CustomStopwordsApi = exports.CustomStopwordsApiFactory = exports.CustomStopwordsApiFp = exports.CustomStopwordsApiAxiosParamCreator = exports.ApiCreditsTransactionsGetTypeEnum = exports.CreditsApi = exports.CreditsApiFactory = exports.CreditsApiFp = exports.CreditsApiAxiosParamCreator = exports.ConnectorsApi = exports.ConnectorsApiFactory = exports.ConnectorsApiFp = exports.ConnectorsApiAxiosParamCreator = exports.AuthApi = exports.AuthApiFactory = exports.AuthApiFp = exports.AuthApiAxiosParamCreator = exports.ArticlesApi = exports.ArticlesApiFactory = exports.ArticlesApiFp = exports.ArticlesApiAxiosParamCreator = exports.AnalyticsEventsApi = exports.AnalyticsEventsApiFactory = exports.AnalyticsEventsApiFp = exports.AnalyticsEventsApiAxiosParamCreator = exports.AdminAnalyticsStoreXStoreIDTagsSummaryGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDTagsSummaryGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDTagsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDTagsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDResultsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum = void 0;
|
|
27
|
+
exports.PaymentsApiAxiosParamCreator = exports.PaymentGatewayApi = exports.PaymentGatewayApiFactory = exports.PaymentGatewayApiFp = exports.PaymentGatewayApiAxiosParamCreator = exports.ParentMenusApi = exports.ParentMenusApiFactory = exports.ParentMenusApiFp = exports.ParentMenusApiAxiosParamCreator = exports.OrganizationsApi = exports.OrganizationsApiFactory = exports.OrganizationsApiFp = exports.OrganizationsApiAxiosParamCreator = exports.OnboardingApi = exports.OnboardingApiFactory = exports.OnboardingApiFp = exports.OnboardingApiAxiosParamCreator = exports.NewsLettersApi = exports.NewsLettersApiFactory = exports.NewsLettersApiFp = exports.NewsLettersApiAxiosParamCreator = exports.MongoDbApi = exports.MongoDbApiFactory = exports.MongoDbApiFp = exports.MongoDbApiAxiosParamCreator = exports.ModulesApi = exports.ModulesApiFactory = exports.ModulesApiFp = exports.ModulesApiAxiosParamCreator = exports.MenusApi = exports.MenusApiFactory = exports.MenusApiFp = exports.MenusApiAxiosParamCreator = exports.LimitsApi = exports.LimitsApiFactory = exports.LimitsApiFp = exports.LimitsApiAxiosParamCreator = exports.AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDItemsTrendsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDItemsTrendsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDItemsTrendsGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDItemsPerformanceGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDItemsPerformanceGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum = exports.AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDItemsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDItemsDiscoveryGetSortOrderEnum = void 0;
|
|
28
|
+
exports.StoresApiAxiosParamCreator = exports.StoreDocumentsApi = exports.StoreDocumentsApiFactory = exports.StoreDocumentsApiFp = exports.StoreDocumentsApiAxiosParamCreator = exports.StopwordsApi = exports.StopwordsApiFactory = exports.StopwordsApiFp = exports.StopwordsApiAxiosParamCreator = exports.SearchApi = exports.SearchApiFactory = exports.SearchApiFp = exports.SearchApiAxiosParamCreator = exports.RolesApi = exports.RolesApiFactory = exports.RolesApiFp = exports.RolesApiAxiosParamCreator = exports.RoleRightsApi = exports.RoleRightsApiFactory = exports.RoleRightsApiFp = exports.RoleRightsApiAxiosParamCreator = exports.RequestsApi = exports.RequestsApiFactory = exports.RequestsApiFp = exports.RequestsApiAxiosParamCreator = exports.RegisterApi = exports.RegisterApiFactory = exports.RegisterApiFp = exports.RegisterApiAxiosParamCreator = exports.QuerySuggestionsManagementApi = exports.QuerySuggestionsManagementApiFactory = exports.QuerySuggestionsManagementApiFp = exports.QuerySuggestionsManagementApiAxiosParamCreator = exports.V1SuggestionsQueriesGetTimeRangeEnum = exports.V1SuggestionsQueriesGetTagsMatchModeEnum = exports.QuerySuggestionsApi = exports.QuerySuggestionsApiFactory = exports.QuerySuggestionsApiFp = exports.QuerySuggestionsApiAxiosParamCreator = exports.PluralsDeclensionsApi = exports.PluralsDeclensionsApiFactory = exports.PluralsDeclensionsApiFp = exports.PluralsDeclensionsApiAxiosParamCreator = exports.PlansApi = exports.PlansApiFactory = exports.PlansApiFp = exports.PlansApiAxiosParamCreator = exports.PaymentsApi = exports.PaymentsApiFactory = exports.PaymentsApiFp = void 0;
|
|
29
|
+
exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiAxiosParamCreator = exports.SubscriptionsApi = exports.SubscriptionsApiFactory = exports.SubscriptionsApiFp = exports.SubscriptionsApiAxiosParamCreator = exports.StoresApi = exports.StoresApiFactory = exports.StoresApiFp = void 0;
|
|
29
30
|
const axios_1 = require("axios");
|
|
30
31
|
// Some imports not used depending on template conditions
|
|
31
32
|
// @ts-ignore
|
|
32
33
|
const common_1 = require("./common");
|
|
33
34
|
// @ts-ignore
|
|
34
35
|
const base_1 = require("./base");
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @export
|
|
39
|
+
* @enum {string}
|
|
40
|
+
*/
|
|
41
|
+
exports.AnalyticsBulkOperation = {
|
|
42
|
+
BulkEnable: 'enable',
|
|
43
|
+
BulkDisable: 'disable',
|
|
44
|
+
BulkDelete: 'delete',
|
|
45
|
+
BulkUpdatePriority: 'update_priority'
|
|
46
|
+
};
|
|
47
|
+
/**
|
|
48
|
+
*
|
|
49
|
+
* @export
|
|
50
|
+
* @enum {string}
|
|
51
|
+
*/
|
|
52
|
+
exports.AnalyticsQuerySuggestionSource = {
|
|
53
|
+
SourceAutoGenerated: 'auto_generated',
|
|
54
|
+
SourceManual: 'manual',
|
|
55
|
+
SourceImported: 'imported'
|
|
56
|
+
};
|
|
57
|
+
/**
|
|
58
|
+
*
|
|
59
|
+
* @export
|
|
60
|
+
* @enum {string}
|
|
61
|
+
*/
|
|
62
|
+
exports.AnalyticsQuerySuggestionStatus = {
|
|
63
|
+
StatusEnabled: 'enabled',
|
|
64
|
+
StatusDisabled: 'disabled'
|
|
65
|
+
};
|
|
35
66
|
exports.DataTypesCreateCustomWordListRequestTypeEnum = {
|
|
36
67
|
Stopwords: 'stopwords',
|
|
37
68
|
Synonyms: 'synonyms'
|
|
@@ -1456,6 +1487,133 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1456
1487
|
options: localVarRequestOptions,
|
|
1457
1488
|
};
|
|
1458
1489
|
}),
|
|
1490
|
+
/**
|
|
1491
|
+
* Retrieve comprehensive analytics insights for a specific geographic location including all core metrics (Total Searches, Total Clicks, CTR, Conversions, CVR, Revenue), popular queries with performance metrics, top results by region with average rankings, popular filters used per region with performance impact, and totals & rates with optional comparison mode and internal pagination for each subsection
|
|
1492
|
+
* @summary Get Geographic Insights
|
|
1493
|
+
* @param {string} xStoreID Store ID
|
|
1494
|
+
* @param {string} [country] Country name to analyze
|
|
1495
|
+
* @param {string} [region] Region/state name to analyze
|
|
1496
|
+
* @param {string} [city] City name to analyze
|
|
1497
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
1498
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
1499
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
1500
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
1501
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
1502
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
1503
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
1504
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
1505
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
1506
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
1507
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
1508
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
1509
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
1510
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
1511
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
1512
|
+
* @param {number} [queriesPage] Page number for popular queries pagination
|
|
1513
|
+
* @param {number} [queriesPageSize] Number of queries per page for popular queries
|
|
1514
|
+
* @param {number} [resultsPage] Page number for top results pagination
|
|
1515
|
+
* @param {number} [resultsPageSize] Number of results per page for top results
|
|
1516
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
1517
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
1518
|
+
* @param {*} [options] Override http request option.
|
|
1519
|
+
* @throws {RequiredError}
|
|
1520
|
+
*/
|
|
1521
|
+
adminAnalyticsStoreXStoreIDGeoInsightsGet: (xStoreID_1, country_1, region_1, city_1, startTime_1, endTime_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, queriesPage_1, queriesPageSize_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, ...args_1) => __awaiter(this, [xStoreID_1, country_1, region_1, city_1, startTime_1, endTime_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, queriesPage_1, queriesPageSize_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, ...args_1], void 0, function* (xStoreID, country, region, city, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, queriesPage, queriesPageSize, resultsPage, resultsPageSize, filtersPage, filtersPageSize, options = {}) {
|
|
1522
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
1523
|
+
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDGeoInsightsGet', 'xStoreID', xStoreID);
|
|
1524
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/geo/insights`
|
|
1525
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
1526
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1527
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1528
|
+
let baseOptions;
|
|
1529
|
+
if (configuration) {
|
|
1530
|
+
baseOptions = configuration.baseOptions;
|
|
1531
|
+
}
|
|
1532
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1533
|
+
const localVarHeaderParameter = {};
|
|
1534
|
+
const localVarQueryParameter = {};
|
|
1535
|
+
// authentication BearerAuth required
|
|
1536
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
1537
|
+
if (country !== undefined) {
|
|
1538
|
+
localVarQueryParameter['country'] = country;
|
|
1539
|
+
}
|
|
1540
|
+
if (region !== undefined) {
|
|
1541
|
+
localVarQueryParameter['region'] = region;
|
|
1542
|
+
}
|
|
1543
|
+
if (city !== undefined) {
|
|
1544
|
+
localVarQueryParameter['city'] = city;
|
|
1545
|
+
}
|
|
1546
|
+
if (startTime !== undefined) {
|
|
1547
|
+
localVarQueryParameter['start_time'] = startTime;
|
|
1548
|
+
}
|
|
1549
|
+
if (endTime !== undefined) {
|
|
1550
|
+
localVarQueryParameter['end_time'] = endTime;
|
|
1551
|
+
}
|
|
1552
|
+
if (analyticsTags !== undefined) {
|
|
1553
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
1554
|
+
}
|
|
1555
|
+
if (tagsMatchMode !== undefined) {
|
|
1556
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
1557
|
+
}
|
|
1558
|
+
if (tagsExclude !== undefined) {
|
|
1559
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
1560
|
+
}
|
|
1561
|
+
if (tagKeyFilter !== undefined) {
|
|
1562
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
1563
|
+
}
|
|
1564
|
+
if (tagValueFilter !== undefined) {
|
|
1565
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
1566
|
+
}
|
|
1567
|
+
if (compareMode !== undefined) {
|
|
1568
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
1569
|
+
}
|
|
1570
|
+
if (compareStartTime !== undefined) {
|
|
1571
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
1572
|
+
}
|
|
1573
|
+
if (compareEndTime !== undefined) {
|
|
1574
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
1575
|
+
}
|
|
1576
|
+
if (compareAnalyticsTags !== undefined) {
|
|
1577
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
1578
|
+
}
|
|
1579
|
+
if (compareTagsMatchMode !== undefined) {
|
|
1580
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
1581
|
+
}
|
|
1582
|
+
if (compareTagsExclude !== undefined) {
|
|
1583
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
1584
|
+
}
|
|
1585
|
+
if (compareTagKeyFilter !== undefined) {
|
|
1586
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
1587
|
+
}
|
|
1588
|
+
if (compareTagValueFilter !== undefined) {
|
|
1589
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
1590
|
+
}
|
|
1591
|
+
if (queriesPage !== undefined) {
|
|
1592
|
+
localVarQueryParameter['queries_page'] = queriesPage;
|
|
1593
|
+
}
|
|
1594
|
+
if (queriesPageSize !== undefined) {
|
|
1595
|
+
localVarQueryParameter['queries_page_size'] = queriesPageSize;
|
|
1596
|
+
}
|
|
1597
|
+
if (resultsPage !== undefined) {
|
|
1598
|
+
localVarQueryParameter['results_page'] = resultsPage;
|
|
1599
|
+
}
|
|
1600
|
+
if (resultsPageSize !== undefined) {
|
|
1601
|
+
localVarQueryParameter['results_page_size'] = resultsPageSize;
|
|
1602
|
+
}
|
|
1603
|
+
if (filtersPage !== undefined) {
|
|
1604
|
+
localVarQueryParameter['filters_page'] = filtersPage;
|
|
1605
|
+
}
|
|
1606
|
+
if (filtersPageSize !== undefined) {
|
|
1607
|
+
localVarQueryParameter['filters_page_size'] = filtersPageSize;
|
|
1608
|
+
}
|
|
1609
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1610
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1611
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1612
|
+
return {
|
|
1613
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1614
|
+
options: localVarRequestOptions,
|
|
1615
|
+
};
|
|
1616
|
+
}),
|
|
1459
1617
|
/**
|
|
1460
1618
|
* Check the health status of analytics service and ClickHouse connection
|
|
1461
1619
|
* @summary Analytics Health Check
|
|
@@ -2007,7 +2165,7 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2007
2165
|
};
|
|
2008
2166
|
}),
|
|
2009
2167
|
/**
|
|
2010
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
2168
|
+
* Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
2011
2169
|
* @summary Get Query Insights
|
|
2012
2170
|
* @param {string} xStoreID Store ID
|
|
2013
2171
|
* @param {string} query Search query to analyze
|
|
@@ -2024,12 +2182,14 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2024
2182
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
2025
2183
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
2026
2184
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
2027
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
2185
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
2186
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
2187
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
2028
2188
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
2029
2189
|
* @param {*} [options] Override http request option.
|
|
2030
2190
|
* @throws {RequiredError}
|
|
2031
2191
|
*/
|
|
2032
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: (xStoreID_1, query_1, startTime_1, endTime_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, includeWidget_1, ...args_1) => __awaiter(this, [xStoreID_1, query_1, startTime_1, endTime_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, includeWidget_1, ...args_1], void 0, function* (xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options = {}) {
|
|
2192
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: (xStoreID_1, query_1, startTime_1, endTime_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, geoPage_1, geoPageSize_1, includeWidget_1, ...args_1) => __awaiter(this, [xStoreID_1, query_1, startTime_1, endTime_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, geoPage_1, geoPageSize_1, includeWidget_1, ...args_1], void 0, function* (xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options = {}) {
|
|
2033
2193
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
2034
2194
|
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet', 'xStoreID', xStoreID);
|
|
2035
2195
|
// verify required parameter 'query' is not null or undefined
|
|
@@ -2090,6 +2250,12 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2090
2250
|
if (filtersPageSize !== undefined) {
|
|
2091
2251
|
localVarQueryParameter['filters_page_size'] = filtersPageSize;
|
|
2092
2252
|
}
|
|
2253
|
+
if (geoPage !== undefined) {
|
|
2254
|
+
localVarQueryParameter['geo_page'] = geoPage;
|
|
2255
|
+
}
|
|
2256
|
+
if (geoPageSize !== undefined) {
|
|
2257
|
+
localVarQueryParameter['geo_page_size'] = geoPageSize;
|
|
2258
|
+
}
|
|
2093
2259
|
if (includeWidget !== undefined) {
|
|
2094
2260
|
localVarQueryParameter['include_widget'] = includeWidget;
|
|
2095
2261
|
}
|
|
@@ -2572,6 +2738,46 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2572
2738
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2573
2739
|
});
|
|
2574
2740
|
},
|
|
2741
|
+
/**
|
|
2742
|
+
* Retrieve comprehensive analytics insights for a specific geographic location including all core metrics (Total Searches, Total Clicks, CTR, Conversions, CVR, Revenue), popular queries with performance metrics, top results by region with average rankings, popular filters used per region with performance impact, and totals & rates with optional comparison mode and internal pagination for each subsection
|
|
2743
|
+
* @summary Get Geographic Insights
|
|
2744
|
+
* @param {string} xStoreID Store ID
|
|
2745
|
+
* @param {string} [country] Country name to analyze
|
|
2746
|
+
* @param {string} [region] Region/state name to analyze
|
|
2747
|
+
* @param {string} [city] City name to analyze
|
|
2748
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
2749
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
2750
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2751
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2752
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2753
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2754
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2755
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2756
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2757
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2758
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2759
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2760
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2761
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2762
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2763
|
+
* @param {number} [queriesPage] Page number for popular queries pagination
|
|
2764
|
+
* @param {number} [queriesPageSize] Number of queries per page for popular queries
|
|
2765
|
+
* @param {number} [resultsPage] Page number for top results pagination
|
|
2766
|
+
* @param {number} [resultsPageSize] Number of results per page for top results
|
|
2767
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
2768
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
2769
|
+
* @param {*} [options] Override http request option.
|
|
2770
|
+
* @throws {RequiredError}
|
|
2771
|
+
*/
|
|
2772
|
+
adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID, country, region, city, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, queriesPage, queriesPageSize, resultsPage, resultsPageSize, filtersPage, filtersPageSize, options) {
|
|
2773
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2774
|
+
var _a, _b, _c;
|
|
2775
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID, country, region, city, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, queriesPage, queriesPageSize, resultsPage, resultsPageSize, filtersPage, filtersPageSize, options);
|
|
2776
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2777
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDGeoInsightsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2778
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2779
|
+
});
|
|
2780
|
+
},
|
|
2575
2781
|
/**
|
|
2576
2782
|
* Check the health status of analytics service and ClickHouse connection
|
|
2577
2783
|
* @summary Analytics Health Check
|
|
@@ -2760,7 +2966,7 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2760
2966
|
});
|
|
2761
2967
|
},
|
|
2762
2968
|
/**
|
|
2763
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
2969
|
+
* Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
2764
2970
|
* @summary Get Query Insights
|
|
2765
2971
|
* @param {string} xStoreID Store ID
|
|
2766
2972
|
* @param {string} query Search query to analyze
|
|
@@ -2777,15 +2983,17 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2777
2983
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
2778
2984
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
2779
2985
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
2780
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
2986
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
2987
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
2988
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
2781
2989
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
2782
2990
|
* @param {*} [options] Override http request option.
|
|
2783
2991
|
* @throws {RequiredError}
|
|
2784
2992
|
*/
|
|
2785
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
|
|
2993
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options) {
|
|
2786
2994
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2787
2995
|
var _a, _b, _c;
|
|
2788
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options);
|
|
2996
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options);
|
|
2789
2997
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2790
2998
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2791
2999
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -3035,6 +3243,40 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
3035
3243
|
adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
3036
3244
|
return localVarFp.adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, 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));
|
|
3037
3245
|
},
|
|
3246
|
+
/**
|
|
3247
|
+
* Retrieve comprehensive analytics insights for a specific geographic location including all core metrics (Total Searches, Total Clicks, CTR, Conversions, CVR, Revenue), popular queries with performance metrics, top results by region with average rankings, popular filters used per region with performance impact, and totals & rates with optional comparison mode and internal pagination for each subsection
|
|
3248
|
+
* @summary Get Geographic Insights
|
|
3249
|
+
* @param {string} xStoreID Store ID
|
|
3250
|
+
* @param {string} [country] Country name to analyze
|
|
3251
|
+
* @param {string} [region] Region/state name to analyze
|
|
3252
|
+
* @param {string} [city] City name to analyze
|
|
3253
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
3254
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
3255
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3256
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3257
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3258
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3259
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3260
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3261
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3262
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3263
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3264
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3265
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3266
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3267
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3268
|
+
* @param {number} [queriesPage] Page number for popular queries pagination
|
|
3269
|
+
* @param {number} [queriesPageSize] Number of queries per page for popular queries
|
|
3270
|
+
* @param {number} [resultsPage] Page number for top results pagination
|
|
3271
|
+
* @param {number} [resultsPageSize] Number of results per page for top results
|
|
3272
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
3273
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
3274
|
+
* @param {*} [options] Override http request option.
|
|
3275
|
+
* @throws {RequiredError}
|
|
3276
|
+
*/
|
|
3277
|
+
adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID, country, region, city, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, queriesPage, queriesPageSize, resultsPage, resultsPageSize, filtersPage, filtersPageSize, options) {
|
|
3278
|
+
return localVarFp.adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID, country, region, city, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, queriesPage, queriesPageSize, resultsPage, resultsPageSize, filtersPage, filtersPageSize, options).then((request) => request(axios, basePath));
|
|
3279
|
+
},
|
|
3038
3280
|
/**
|
|
3039
3281
|
* Check the health status of analytics service and ClickHouse connection
|
|
3040
3282
|
* @summary Analytics Health Check
|
|
@@ -3187,7 +3429,7 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
3187
3429
|
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));
|
|
3188
3430
|
},
|
|
3189
3431
|
/**
|
|
3190
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
3432
|
+
* Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
3191
3433
|
* @summary Get Query Insights
|
|
3192
3434
|
* @param {string} xStoreID Store ID
|
|
3193
3435
|
* @param {string} query Search query to analyze
|
|
@@ -3204,13 +3446,15 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
3204
3446
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
3205
3447
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
3206
3448
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
3207
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
3449
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
3450
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
3451
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
3208
3452
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
3209
3453
|
* @param {*} [options] Override http request option.
|
|
3210
3454
|
* @throws {RequiredError}
|
|
3211
3455
|
*/
|
|
3212
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
|
|
3213
|
-
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(axios, basePath));
|
|
3456
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options) {
|
|
3457
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options).then((request) => request(axios, basePath));
|
|
3214
3458
|
},
|
|
3215
3459
|
/**
|
|
3216
3460
|
* 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.
|
|
@@ -3445,6 +3689,41 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
3445
3689
|
adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
3446
3690
|
return (0, exports.AnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, 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));
|
|
3447
3691
|
}
|
|
3692
|
+
/**
|
|
3693
|
+
* Retrieve comprehensive analytics insights for a specific geographic location including all core metrics (Total Searches, Total Clicks, CTR, Conversions, CVR, Revenue), popular queries with performance metrics, top results by region with average rankings, popular filters used per region with performance impact, and totals & rates with optional comparison mode and internal pagination for each subsection
|
|
3694
|
+
* @summary Get Geographic Insights
|
|
3695
|
+
* @param {string} xStoreID Store ID
|
|
3696
|
+
* @param {string} [country] Country name to analyze
|
|
3697
|
+
* @param {string} [region] Region/state name to analyze
|
|
3698
|
+
* @param {string} [city] City name to analyze
|
|
3699
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
3700
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
3701
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3702
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3703
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3704
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3705
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3706
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3707
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3708
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3709
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3710
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3711
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3712
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3713
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3714
|
+
* @param {number} [queriesPage] Page number for popular queries pagination
|
|
3715
|
+
* @param {number} [queriesPageSize] Number of queries per page for popular queries
|
|
3716
|
+
* @param {number} [resultsPage] Page number for top results pagination
|
|
3717
|
+
* @param {number} [resultsPageSize] Number of results per page for top results
|
|
3718
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
3719
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
3720
|
+
* @param {*} [options] Override http request option.
|
|
3721
|
+
* @throws {RequiredError}
|
|
3722
|
+
* @memberof AnalyticsApi
|
|
3723
|
+
*/
|
|
3724
|
+
adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID, country, region, city, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, queriesPage, queriesPageSize, resultsPage, resultsPageSize, filtersPage, filtersPageSize, options) {
|
|
3725
|
+
return (0, exports.AnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID, country, region, city, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, queriesPage, queriesPageSize, resultsPage, resultsPageSize, filtersPage, filtersPageSize, options).then((request) => request(this.axios, this.basePath));
|
|
3726
|
+
}
|
|
3448
3727
|
/**
|
|
3449
3728
|
* Check the health status of analytics service and ClickHouse connection
|
|
3450
3729
|
* @summary Analytics Health Check
|
|
@@ -3603,7 +3882,7 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
3603
3882
|
return (0, exports.AnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
3604
3883
|
}
|
|
3605
3884
|
/**
|
|
3606
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
3885
|
+
* Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
3607
3886
|
* @summary Get Query Insights
|
|
3608
3887
|
* @param {string} xStoreID Store ID
|
|
3609
3888
|
* @param {string} query Search query to analyze
|
|
@@ -3620,14 +3899,16 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
3620
3899
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
3621
3900
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
3622
3901
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
3623
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
3902
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
3903
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
3904
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
3624
3905
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
3625
3906
|
* @param {*} [options] Override http request option.
|
|
3626
3907
|
* @throws {RequiredError}
|
|
3627
3908
|
* @memberof AnalyticsApi
|
|
3628
3909
|
*/
|
|
3629
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
|
|
3630
|
-
return (0, exports.AnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(this.axios, this.basePath));
|
|
3910
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options) {
|
|
3911
|
+
return (0, exports.AnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options).then((request) => request(this.axios, this.basePath));
|
|
3631
3912
|
}
|
|
3632
3913
|
/**
|
|
3633
3914
|
* 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.
|
|
@@ -3842,6 +4123,20 @@ exports.AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum = {
|
|
|
3842
4123
|
Asc: 'asc',
|
|
3843
4124
|
Desc: 'desc'
|
|
3844
4125
|
};
|
|
4126
|
+
/**
|
|
4127
|
+
* @export
|
|
4128
|
+
*/
|
|
4129
|
+
exports.AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum = {
|
|
4130
|
+
Any: 'any',
|
|
4131
|
+
All: 'all'
|
|
4132
|
+
};
|
|
4133
|
+
/**
|
|
4134
|
+
* @export
|
|
4135
|
+
*/
|
|
4136
|
+
exports.AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum = {
|
|
4137
|
+
Any: 'any',
|
|
4138
|
+
All: 'all'
|
|
4139
|
+
};
|
|
3845
4140
|
/**
|
|
3846
4141
|
* @export
|
|
3847
4142
|
*/
|
|
@@ -7445,30 +7740,43 @@ const ItemAnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
7445
7740
|
};
|
|
7446
7741
|
}),
|
|
7447
7742
|
/**
|
|
7448
|
-
* Retrieve
|
|
7449
|
-
* @summary Get Item
|
|
7743
|
+
* Retrieve comprehensive analytics insights for a specific item including all core metrics (Total Searches, Results Shown, Impressions, Clicks, Conversions, Revenue, CTR, CVR, Conversion Rate per Search, No-Click Rate, Avg Result Rank, Avg Click Position), popular queries, filters, position distribution, geo analytics, and performance metrics with pagination support for subsections and optional comparison mode
|
|
7744
|
+
* @summary Get Item Insights
|
|
7450
7745
|
* @param {string} xStoreID Store ID
|
|
7746
|
+
* @param {string} itemId Item ID to analyze
|
|
7451
7747
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
7452
7748
|
* @param {string} [endTime] End time in RFC3339 format
|
|
7453
|
-
* @param {string} [
|
|
7454
|
-
* @param {
|
|
7455
|
-
* @param {
|
|
7456
|
-
* @param {
|
|
7457
|
-
* @param {
|
|
7458
|
-
* @param {
|
|
7459
|
-
* @param {string} [
|
|
7460
|
-
* @param {
|
|
7461
|
-
* @param {
|
|
7462
|
-
* @param {
|
|
7463
|
-
* @param {
|
|
7749
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
7750
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
7751
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
7752
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
7753
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
7754
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
7755
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
7756
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
7757
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
7758
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
7759
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
7760
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
7761
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
7762
|
+
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
7763
|
+
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
7764
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
7765
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
7766
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
7767
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
7768
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
7464
7769
|
* @param {*} [options] Override http request option.
|
|
7465
7770
|
* @throws {RequiredError}
|
|
7466
7771
|
*/
|
|
7467
|
-
|
|
7772
|
+
adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet: (xStoreID_1, itemId_1, startTime_1, endTime_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, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, geoPage_1, geoPageSize_1, groupBy_1, ...args_1) => __awaiter(this, [xStoreID_1, itemId_1, startTime_1, endTime_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, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, geoPage_1, geoPageSize_1, groupBy_1, ...args_1], void 0, function* (xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options = {}) {
|
|
7468
7773
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
7469
|
-
(0, common_1.assertParamExists)('
|
|
7470
|
-
|
|
7471
|
-
|
|
7774
|
+
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet', 'xStoreID', xStoreID);
|
|
7775
|
+
// verify required parameter 'itemId' is not null or undefined
|
|
7776
|
+
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet', 'itemId', itemId);
|
|
7777
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/items/{itemId}/insights`
|
|
7778
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)))
|
|
7779
|
+
.replace(`{${"itemId"}}`, encodeURIComponent(String(itemId)));
|
|
7472
7780
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7473
7781
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
7474
7782
|
let baseOptions;
|
|
@@ -7486,26 +7794,136 @@ const ItemAnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
7486
7794
|
if (endTime !== undefined) {
|
|
7487
7795
|
localVarQueryParameter['end_time'] = endTime;
|
|
7488
7796
|
}
|
|
7489
|
-
if (
|
|
7490
|
-
localVarQueryParameter['
|
|
7491
|
-
}
|
|
7492
|
-
if (itemLimit !== undefined) {
|
|
7493
|
-
localVarQueryParameter['item_limit'] = itemLimit;
|
|
7797
|
+
if (analyticsTags !== undefined) {
|
|
7798
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
7494
7799
|
}
|
|
7495
|
-
if (
|
|
7496
|
-
localVarQueryParameter['
|
|
7800
|
+
if (tagsMatchMode !== undefined) {
|
|
7801
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
7497
7802
|
}
|
|
7498
|
-
if (
|
|
7499
|
-
localVarQueryParameter['
|
|
7803
|
+
if (tagsExclude !== undefined) {
|
|
7804
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
7500
7805
|
}
|
|
7501
|
-
if (
|
|
7502
|
-
localVarQueryParameter['
|
|
7806
|
+
if (tagKeyFilter !== undefined) {
|
|
7807
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
7503
7808
|
}
|
|
7504
|
-
if (
|
|
7505
|
-
localVarQueryParameter['
|
|
7809
|
+
if (tagValueFilter !== undefined) {
|
|
7810
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
7506
7811
|
}
|
|
7507
|
-
if (
|
|
7508
|
-
localVarQueryParameter['
|
|
7812
|
+
if (compareMode !== undefined) {
|
|
7813
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
7814
|
+
}
|
|
7815
|
+
if (compareStartTime !== undefined) {
|
|
7816
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
7817
|
+
}
|
|
7818
|
+
if (compareEndTime !== undefined) {
|
|
7819
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
7820
|
+
}
|
|
7821
|
+
if (compareAnalyticsTags !== undefined) {
|
|
7822
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
7823
|
+
}
|
|
7824
|
+
if (compareTagsMatchMode !== undefined) {
|
|
7825
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
7826
|
+
}
|
|
7827
|
+
if (compareTagsExclude !== undefined) {
|
|
7828
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
7829
|
+
}
|
|
7830
|
+
if (compareTagKeyFilter !== undefined) {
|
|
7831
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
7832
|
+
}
|
|
7833
|
+
if (compareTagValueFilter !== undefined) {
|
|
7834
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
7835
|
+
}
|
|
7836
|
+
if (resultsPage !== undefined) {
|
|
7837
|
+
localVarQueryParameter['results_page'] = resultsPage;
|
|
7838
|
+
}
|
|
7839
|
+
if (resultsPageSize !== undefined) {
|
|
7840
|
+
localVarQueryParameter['results_page_size'] = resultsPageSize;
|
|
7841
|
+
}
|
|
7842
|
+
if (filtersPage !== undefined) {
|
|
7843
|
+
localVarQueryParameter['filters_page'] = filtersPage;
|
|
7844
|
+
}
|
|
7845
|
+
if (filtersPageSize !== undefined) {
|
|
7846
|
+
localVarQueryParameter['filters_page_size'] = filtersPageSize;
|
|
7847
|
+
}
|
|
7848
|
+
if (geoPage !== undefined) {
|
|
7849
|
+
localVarQueryParameter['geo_page'] = geoPage;
|
|
7850
|
+
}
|
|
7851
|
+
if (geoPageSize !== undefined) {
|
|
7852
|
+
localVarQueryParameter['geo_page_size'] = geoPageSize;
|
|
7853
|
+
}
|
|
7854
|
+
if (groupBy !== undefined) {
|
|
7855
|
+
localVarQueryParameter['group_by'] = groupBy;
|
|
7856
|
+
}
|
|
7857
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
7858
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7859
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
7860
|
+
return {
|
|
7861
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
7862
|
+
options: localVarRequestOptions,
|
|
7863
|
+
};
|
|
7864
|
+
}),
|
|
7865
|
+
/**
|
|
7866
|
+
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
7867
|
+
* @summary Get Item Performance Analytics
|
|
7868
|
+
* @param {string} xStoreID Store ID
|
|
7869
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
7870
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
7871
|
+
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
7872
|
+
* @param {number} [itemLimit] Maximum number of items to return
|
|
7873
|
+
* @param {number} [minImpressions] Minimum number of impressions required
|
|
7874
|
+
* @param {number} [maxPosition] Maximum position to include
|
|
7875
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsPerformanceGetSortByEnum} [sortBy] Field to sort by
|
|
7876
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsPerformanceGetSortOrderEnum} [sortOrder] Sort direction
|
|
7877
|
+
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
7878
|
+
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
7879
|
+
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
7880
|
+
* @param {number} [page] Page number for pagination
|
|
7881
|
+
* @param {number} [pageSize] Number of results per page
|
|
7882
|
+
* @param {*} [options] Override http request option.
|
|
7883
|
+
* @throws {RequiredError}
|
|
7884
|
+
*/
|
|
7885
|
+
adminAnalyticsStoreXStoreIDItemsPerformanceGet: (xStoreID_1, startTime_1, endTime_1, itemIds_1, itemLimit_1, minImpressions_1, maxPosition_1, sortBy_1, sortOrder_1, sort_1, limit_1, offset_1, page_1, pageSize_1, ...args_1) => __awaiter(this, [xStoreID_1, startTime_1, endTime_1, itemIds_1, itemLimit_1, minImpressions_1, maxPosition_1, sortBy_1, sortOrder_1, sort_1, limit_1, offset_1, page_1, pageSize_1, ...args_1], void 0, function* (xStoreID, startTime, endTime, itemIds, itemLimit, minImpressions, maxPosition, sortBy, sortOrder, sort, limit, offset, page, pageSize, options = {}) {
|
|
7886
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
7887
|
+
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDItemsPerformanceGet', 'xStoreID', xStoreID);
|
|
7888
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/items/performance`
|
|
7889
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
7890
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7891
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
7892
|
+
let baseOptions;
|
|
7893
|
+
if (configuration) {
|
|
7894
|
+
baseOptions = configuration.baseOptions;
|
|
7895
|
+
}
|
|
7896
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
7897
|
+
const localVarHeaderParameter = {};
|
|
7898
|
+
const localVarQueryParameter = {};
|
|
7899
|
+
// authentication BearerAuth required
|
|
7900
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
7901
|
+
if (startTime !== undefined) {
|
|
7902
|
+
localVarQueryParameter['start_time'] = startTime;
|
|
7903
|
+
}
|
|
7904
|
+
if (endTime !== undefined) {
|
|
7905
|
+
localVarQueryParameter['end_time'] = endTime;
|
|
7906
|
+
}
|
|
7907
|
+
if (itemIds !== undefined) {
|
|
7908
|
+
localVarQueryParameter['item_ids'] = itemIds;
|
|
7909
|
+
}
|
|
7910
|
+
if (itemLimit !== undefined) {
|
|
7911
|
+
localVarQueryParameter['item_limit'] = itemLimit;
|
|
7912
|
+
}
|
|
7913
|
+
if (minImpressions !== undefined) {
|
|
7914
|
+
localVarQueryParameter['min_impressions'] = minImpressions;
|
|
7915
|
+
}
|
|
7916
|
+
if (maxPosition !== undefined) {
|
|
7917
|
+
localVarQueryParameter['max_position'] = maxPosition;
|
|
7918
|
+
}
|
|
7919
|
+
if (sortBy !== undefined) {
|
|
7920
|
+
localVarQueryParameter['sort_by'] = sortBy;
|
|
7921
|
+
}
|
|
7922
|
+
if (sortOrder !== undefined) {
|
|
7923
|
+
localVarQueryParameter['sort_order'] = sortOrder;
|
|
7924
|
+
}
|
|
7925
|
+
if (sort !== undefined) {
|
|
7926
|
+
localVarQueryParameter['sort'] = sort;
|
|
7509
7927
|
}
|
|
7510
7928
|
if (limit !== undefined) {
|
|
7511
7929
|
localVarQueryParameter['limit'] = limit;
|
|
@@ -7795,6 +8213,45 @@ const ItemAnalyticsApiFp = function (configuration) {
|
|
|
7795
8213
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7796
8214
|
});
|
|
7797
8215
|
},
|
|
8216
|
+
/**
|
|
8217
|
+
* Retrieve comprehensive analytics insights for a specific item including all core metrics (Total Searches, Results Shown, Impressions, Clicks, Conversions, Revenue, CTR, CVR, Conversion Rate per Search, No-Click Rate, Avg Result Rank, Avg Click Position), popular queries, filters, position distribution, geo analytics, and performance metrics with pagination support for subsections and optional comparison mode
|
|
8218
|
+
* @summary Get Item Insights
|
|
8219
|
+
* @param {string} xStoreID Store ID
|
|
8220
|
+
* @param {string} itemId Item ID to analyze
|
|
8221
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
8222
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
8223
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
8224
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
8225
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
8226
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
8227
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
8228
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
8229
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
8230
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
8231
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
8232
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
8233
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
8234
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
8235
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
8236
|
+
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
8237
|
+
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
8238
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
8239
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
8240
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
8241
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
8242
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
8243
|
+
* @param {*} [options] Override http request option.
|
|
8244
|
+
* @throws {RequiredError}
|
|
8245
|
+
*/
|
|
8246
|
+
adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options) {
|
|
8247
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
8248
|
+
var _a, _b, _c;
|
|
8249
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options);
|
|
8250
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
8251
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ItemAnalyticsApi.adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
8252
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8253
|
+
});
|
|
8254
|
+
},
|
|
7798
8255
|
/**
|
|
7799
8256
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
7800
8257
|
* @summary Get Item Performance Analytics
|
|
@@ -7963,6 +8420,39 @@ const ItemAnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
7963
8420
|
adminAnalyticsStoreXStoreIDItemsItemIdGet(xStoreID, itemId, startTime, endTime, options) {
|
|
7964
8421
|
return localVarFp.adminAnalyticsStoreXStoreIDItemsItemIdGet(xStoreID, itemId, startTime, endTime, options).then((request) => request(axios, basePath));
|
|
7965
8422
|
},
|
|
8423
|
+
/**
|
|
8424
|
+
* Retrieve comprehensive analytics insights for a specific item including all core metrics (Total Searches, Results Shown, Impressions, Clicks, Conversions, Revenue, CTR, CVR, Conversion Rate per Search, No-Click Rate, Avg Result Rank, Avg Click Position), popular queries, filters, position distribution, geo analytics, and performance metrics with pagination support for subsections and optional comparison mode
|
|
8425
|
+
* @summary Get Item Insights
|
|
8426
|
+
* @param {string} xStoreID Store ID
|
|
8427
|
+
* @param {string} itemId Item ID to analyze
|
|
8428
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
8429
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
8430
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
8431
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
8432
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
8433
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
8434
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
8435
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
8436
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
8437
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
8438
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
8439
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
8440
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
8441
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
8442
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
8443
|
+
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
8444
|
+
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
8445
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
8446
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
8447
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
8448
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
8449
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
8450
|
+
* @param {*} [options] Override http request option.
|
|
8451
|
+
* @throws {RequiredError}
|
|
8452
|
+
*/
|
|
8453
|
+
adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options) {
|
|
8454
|
+
return localVarFp.adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options).then((request) => request(axios, basePath));
|
|
8455
|
+
},
|
|
7966
8456
|
/**
|
|
7967
8457
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
7968
8458
|
* @summary Get Item Performance Analytics
|
|
@@ -8117,6 +8607,40 @@ class ItemAnalyticsApi extends base_1.BaseAPI {
|
|
|
8117
8607
|
adminAnalyticsStoreXStoreIDItemsItemIdGet(xStoreID, itemId, startTime, endTime, options) {
|
|
8118
8608
|
return (0, exports.ItemAnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDItemsItemIdGet(xStoreID, itemId, startTime, endTime, options).then((request) => request(this.axios, this.basePath));
|
|
8119
8609
|
}
|
|
8610
|
+
/**
|
|
8611
|
+
* Retrieve comprehensive analytics insights for a specific item including all core metrics (Total Searches, Results Shown, Impressions, Clicks, Conversions, Revenue, CTR, CVR, Conversion Rate per Search, No-Click Rate, Avg Result Rank, Avg Click Position), popular queries, filters, position distribution, geo analytics, and performance metrics with pagination support for subsections and optional comparison mode
|
|
8612
|
+
* @summary Get Item Insights
|
|
8613
|
+
* @param {string} xStoreID Store ID
|
|
8614
|
+
* @param {string} itemId Item ID to analyze
|
|
8615
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
8616
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
8617
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
8618
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
8619
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
8620
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
8621
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
8622
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
8623
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
8624
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
8625
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
8626
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
8627
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
8628
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
8629
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
8630
|
+
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
8631
|
+
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
8632
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
8633
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
8634
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
8635
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
8636
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
8637
|
+
* @param {*} [options] Override http request option.
|
|
8638
|
+
* @throws {RequiredError}
|
|
8639
|
+
* @memberof ItemAnalyticsApi
|
|
8640
|
+
*/
|
|
8641
|
+
adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options) {
|
|
8642
|
+
return (0, exports.ItemAnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options).then((request) => request(this.axios, this.basePath));
|
|
8643
|
+
}
|
|
8120
8644
|
/**
|
|
8121
8645
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
8122
8646
|
* @summary Get Item Performance Analytics
|
|
@@ -8222,6 +8746,26 @@ exports.AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum = {
|
|
|
8222
8746
|
Asc: 'asc',
|
|
8223
8747
|
Desc: 'desc'
|
|
8224
8748
|
};
|
|
8749
|
+
/**
|
|
8750
|
+
* @export
|
|
8751
|
+
*/
|
|
8752
|
+
exports.AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum = {
|
|
8753
|
+
Any: 'any',
|
|
8754
|
+
All: 'all'
|
|
8755
|
+
};
|
|
8756
|
+
/**
|
|
8757
|
+
* @export
|
|
8758
|
+
*/
|
|
8759
|
+
exports.AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum = {
|
|
8760
|
+
Any: 'any',
|
|
8761
|
+
All: 'all'
|
|
8762
|
+
};
|
|
8763
|
+
/**
|
|
8764
|
+
* @export
|
|
8765
|
+
*/
|
|
8766
|
+
exports.AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum = {
|
|
8767
|
+
Date: 'date'
|
|
8768
|
+
};
|
|
8225
8769
|
/**
|
|
8226
8770
|
* @export
|
|
8227
8771
|
*/
|
|
@@ -14443,6 +14987,1468 @@ class PluralsDeclensionsApi extends base_1.BaseAPI {
|
|
|
14443
14987
|
}
|
|
14444
14988
|
}
|
|
14445
14989
|
exports.PluralsDeclensionsApi = PluralsDeclensionsApi;
|
|
14990
|
+
/**
|
|
14991
|
+
* QuerySuggestionsApi - axios parameter creator
|
|
14992
|
+
* @export
|
|
14993
|
+
*/
|
|
14994
|
+
const QuerySuggestionsApiAxiosParamCreator = function (configuration) {
|
|
14995
|
+
return {
|
|
14996
|
+
/**
|
|
14997
|
+
* Retrieve configuration settings for query suggestions API including limits, supported time ranges, and default values
|
|
14998
|
+
* @summary Get Query Suggestions Configuration
|
|
14999
|
+
* @param {string} xStoreid Store ID
|
|
15000
|
+
* @param {string} xStoresecret Store Secret
|
|
15001
|
+
* @param {*} [options] Override http request option.
|
|
15002
|
+
* @throws {RequiredError}
|
|
15003
|
+
*/
|
|
15004
|
+
v1SuggestionsConfigGet: (xStoreid_1, xStoresecret_1, ...args_1) => __awaiter(this, [xStoreid_1, xStoresecret_1, ...args_1], void 0, function* (xStoreid, xStoresecret, options = {}) {
|
|
15005
|
+
// verify required parameter 'xStoreid' is not null or undefined
|
|
15006
|
+
(0, common_1.assertParamExists)('v1SuggestionsConfigGet', 'xStoreid', xStoreid);
|
|
15007
|
+
// verify required parameter 'xStoresecret' is not null or undefined
|
|
15008
|
+
(0, common_1.assertParamExists)('v1SuggestionsConfigGet', 'xStoresecret', xStoresecret);
|
|
15009
|
+
const localVarPath = `/v1/suggestions/config`;
|
|
15010
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15011
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
15012
|
+
let baseOptions;
|
|
15013
|
+
if (configuration) {
|
|
15014
|
+
baseOptions = configuration.baseOptions;
|
|
15015
|
+
}
|
|
15016
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
15017
|
+
const localVarHeaderParameter = {};
|
|
15018
|
+
const localVarQueryParameter = {};
|
|
15019
|
+
if (xStoreid != null) {
|
|
15020
|
+
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
15021
|
+
}
|
|
15022
|
+
if (xStoresecret != null) {
|
|
15023
|
+
localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
|
|
15024
|
+
}
|
|
15025
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
15026
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15027
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15028
|
+
return {
|
|
15029
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
15030
|
+
options: localVarRequestOptions,
|
|
15031
|
+
};
|
|
15032
|
+
}),
|
|
15033
|
+
/**
|
|
15034
|
+
* Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering, and configurable time ranges.
|
|
15035
|
+
* @summary Get Query Suggestions
|
|
15036
|
+
* @param {string} xStoreid Store ID
|
|
15037
|
+
* @param {string} xStoresecret Store Secret
|
|
15038
|
+
* @param {string} [query] Partial query to get suggestions for
|
|
15039
|
+
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
15040
|
+
* @param {number} [page] Page number for pagination
|
|
15041
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
|
|
15042
|
+
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
|
|
15043
|
+
* @param {boolean} [includeCategories] Include category information in suggestions
|
|
15044
|
+
* @param {boolean} [includeFacets] Include popular facets/filters information
|
|
15045
|
+
* @param {number} [maxCategories] Maximum categories per suggestion
|
|
15046
|
+
* @param {number} [maxFacets] Maximum facets per suggestion
|
|
15047
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
15048
|
+
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
|
|
15049
|
+
* @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
|
|
15050
|
+
* @param {*} [options] Override http request option.
|
|
15051
|
+
* @throws {RequiredError}
|
|
15052
|
+
*/
|
|
15053
|
+
v1SuggestionsQueriesGet: (xStoreid_1, xStoresecret_1, query_1, hitsPerPage_1, page_1, analyticsTags_1, tagsMatchMode_1, includeCategories_1, includeFacets_1, maxCategories_1, maxFacets_1, minPopularity_1, timeRange_1, disableTypoTolerance_1, ...args_1) => __awaiter(this, [xStoreid_1, xStoresecret_1, query_1, hitsPerPage_1, page_1, analyticsTags_1, tagsMatchMode_1, includeCategories_1, includeFacets_1, maxCategories_1, maxFacets_1, minPopularity_1, timeRange_1, disableTypoTolerance_1, ...args_1], void 0, function* (xStoreid, xStoresecret, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options = {}) {
|
|
15054
|
+
// verify required parameter 'xStoreid' is not null or undefined
|
|
15055
|
+
(0, common_1.assertParamExists)('v1SuggestionsQueriesGet', 'xStoreid', xStoreid);
|
|
15056
|
+
// verify required parameter 'xStoresecret' is not null or undefined
|
|
15057
|
+
(0, common_1.assertParamExists)('v1SuggestionsQueriesGet', 'xStoresecret', xStoresecret);
|
|
15058
|
+
const localVarPath = `/v1/suggestions/queries`;
|
|
15059
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15060
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
15061
|
+
let baseOptions;
|
|
15062
|
+
if (configuration) {
|
|
15063
|
+
baseOptions = configuration.baseOptions;
|
|
15064
|
+
}
|
|
15065
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
15066
|
+
const localVarHeaderParameter = {};
|
|
15067
|
+
const localVarQueryParameter = {};
|
|
15068
|
+
if (query !== undefined) {
|
|
15069
|
+
localVarQueryParameter['query'] = query;
|
|
15070
|
+
}
|
|
15071
|
+
if (hitsPerPage !== undefined) {
|
|
15072
|
+
localVarQueryParameter['hitsPerPage'] = hitsPerPage;
|
|
15073
|
+
}
|
|
15074
|
+
if (page !== undefined) {
|
|
15075
|
+
localVarQueryParameter['page'] = page;
|
|
15076
|
+
}
|
|
15077
|
+
if (analyticsTags !== undefined) {
|
|
15078
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
15079
|
+
}
|
|
15080
|
+
if (tagsMatchMode !== undefined) {
|
|
15081
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
15082
|
+
}
|
|
15083
|
+
if (includeCategories !== undefined) {
|
|
15084
|
+
localVarQueryParameter['include_categories'] = includeCategories;
|
|
15085
|
+
}
|
|
15086
|
+
if (includeFacets !== undefined) {
|
|
15087
|
+
localVarQueryParameter['include_facets'] = includeFacets;
|
|
15088
|
+
}
|
|
15089
|
+
if (maxCategories !== undefined) {
|
|
15090
|
+
localVarQueryParameter['max_categories'] = maxCategories;
|
|
15091
|
+
}
|
|
15092
|
+
if (maxFacets !== undefined) {
|
|
15093
|
+
localVarQueryParameter['max_facets'] = maxFacets;
|
|
15094
|
+
}
|
|
15095
|
+
if (minPopularity !== undefined) {
|
|
15096
|
+
localVarQueryParameter['min_popularity'] = minPopularity;
|
|
15097
|
+
}
|
|
15098
|
+
if (timeRange !== undefined) {
|
|
15099
|
+
localVarQueryParameter['time_range'] = timeRange;
|
|
15100
|
+
}
|
|
15101
|
+
if (disableTypoTolerance !== undefined) {
|
|
15102
|
+
localVarQueryParameter['disable_typo_tolerance'] = disableTypoTolerance;
|
|
15103
|
+
}
|
|
15104
|
+
if (xStoreid != null) {
|
|
15105
|
+
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
15106
|
+
}
|
|
15107
|
+
if (xStoresecret != null) {
|
|
15108
|
+
localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
|
|
15109
|
+
}
|
|
15110
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
15111
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15112
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15113
|
+
return {
|
|
15114
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
15115
|
+
options: localVarRequestOptions,
|
|
15116
|
+
};
|
|
15117
|
+
}),
|
|
15118
|
+
};
|
|
15119
|
+
};
|
|
15120
|
+
exports.QuerySuggestionsApiAxiosParamCreator = QuerySuggestionsApiAxiosParamCreator;
|
|
15121
|
+
/**
|
|
15122
|
+
* QuerySuggestionsApi - functional programming interface
|
|
15123
|
+
* @export
|
|
15124
|
+
*/
|
|
15125
|
+
const QuerySuggestionsApiFp = function (configuration) {
|
|
15126
|
+
const localVarAxiosParamCreator = (0, exports.QuerySuggestionsApiAxiosParamCreator)(configuration);
|
|
15127
|
+
return {
|
|
15128
|
+
/**
|
|
15129
|
+
* Retrieve configuration settings for query suggestions API including limits, supported time ranges, and default values
|
|
15130
|
+
* @summary Get Query Suggestions Configuration
|
|
15131
|
+
* @param {string} xStoreid Store ID
|
|
15132
|
+
* @param {string} xStoresecret Store Secret
|
|
15133
|
+
* @param {*} [options] Override http request option.
|
|
15134
|
+
* @throws {RequiredError}
|
|
15135
|
+
*/
|
|
15136
|
+
v1SuggestionsConfigGet(xStoreid, xStoresecret, options) {
|
|
15137
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15138
|
+
var _a, _b, _c;
|
|
15139
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1SuggestionsConfigGet(xStoreid, xStoresecret, options);
|
|
15140
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15141
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['QuerySuggestionsApi.v1SuggestionsConfigGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15142
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15143
|
+
});
|
|
15144
|
+
},
|
|
15145
|
+
/**
|
|
15146
|
+
* Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering, and configurable time ranges.
|
|
15147
|
+
* @summary Get Query Suggestions
|
|
15148
|
+
* @param {string} xStoreid Store ID
|
|
15149
|
+
* @param {string} xStoresecret Store Secret
|
|
15150
|
+
* @param {string} [query] Partial query to get suggestions for
|
|
15151
|
+
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
15152
|
+
* @param {number} [page] Page number for pagination
|
|
15153
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
|
|
15154
|
+
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
|
|
15155
|
+
* @param {boolean} [includeCategories] Include category information in suggestions
|
|
15156
|
+
* @param {boolean} [includeFacets] Include popular facets/filters information
|
|
15157
|
+
* @param {number} [maxCategories] Maximum categories per suggestion
|
|
15158
|
+
* @param {number} [maxFacets] Maximum facets per suggestion
|
|
15159
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
15160
|
+
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
|
|
15161
|
+
* @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
|
|
15162
|
+
* @param {*} [options] Override http request option.
|
|
15163
|
+
* @throws {RequiredError}
|
|
15164
|
+
*/
|
|
15165
|
+
v1SuggestionsQueriesGet(xStoreid, xStoresecret, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options) {
|
|
15166
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15167
|
+
var _a, _b, _c;
|
|
15168
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1SuggestionsQueriesGet(xStoreid, xStoresecret, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options);
|
|
15169
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15170
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['QuerySuggestionsApi.v1SuggestionsQueriesGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15171
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15172
|
+
});
|
|
15173
|
+
},
|
|
15174
|
+
};
|
|
15175
|
+
};
|
|
15176
|
+
exports.QuerySuggestionsApiFp = QuerySuggestionsApiFp;
|
|
15177
|
+
/**
|
|
15178
|
+
* QuerySuggestionsApi - factory interface
|
|
15179
|
+
* @export
|
|
15180
|
+
*/
|
|
15181
|
+
const QuerySuggestionsApiFactory = function (configuration, basePath, axios) {
|
|
15182
|
+
const localVarFp = (0, exports.QuerySuggestionsApiFp)(configuration);
|
|
15183
|
+
return {
|
|
15184
|
+
/**
|
|
15185
|
+
* Retrieve configuration settings for query suggestions API including limits, supported time ranges, and default values
|
|
15186
|
+
* @summary Get Query Suggestions Configuration
|
|
15187
|
+
* @param {string} xStoreid Store ID
|
|
15188
|
+
* @param {string} xStoresecret Store Secret
|
|
15189
|
+
* @param {*} [options] Override http request option.
|
|
15190
|
+
* @throws {RequiredError}
|
|
15191
|
+
*/
|
|
15192
|
+
v1SuggestionsConfigGet(xStoreid, xStoresecret, options) {
|
|
15193
|
+
return localVarFp.v1SuggestionsConfigGet(xStoreid, xStoresecret, options).then((request) => request(axios, basePath));
|
|
15194
|
+
},
|
|
15195
|
+
/**
|
|
15196
|
+
* Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering, and configurable time ranges.
|
|
15197
|
+
* @summary Get Query Suggestions
|
|
15198
|
+
* @param {string} xStoreid Store ID
|
|
15199
|
+
* @param {string} xStoresecret Store Secret
|
|
15200
|
+
* @param {string} [query] Partial query to get suggestions for
|
|
15201
|
+
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
15202
|
+
* @param {number} [page] Page number for pagination
|
|
15203
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
|
|
15204
|
+
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
|
|
15205
|
+
* @param {boolean} [includeCategories] Include category information in suggestions
|
|
15206
|
+
* @param {boolean} [includeFacets] Include popular facets/filters information
|
|
15207
|
+
* @param {number} [maxCategories] Maximum categories per suggestion
|
|
15208
|
+
* @param {number} [maxFacets] Maximum facets per suggestion
|
|
15209
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
15210
|
+
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
|
|
15211
|
+
* @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
|
|
15212
|
+
* @param {*} [options] Override http request option.
|
|
15213
|
+
* @throws {RequiredError}
|
|
15214
|
+
*/
|
|
15215
|
+
v1SuggestionsQueriesGet(xStoreid, xStoresecret, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options) {
|
|
15216
|
+
return localVarFp.v1SuggestionsQueriesGet(xStoreid, xStoresecret, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options).then((request) => request(axios, basePath));
|
|
15217
|
+
},
|
|
15218
|
+
};
|
|
15219
|
+
};
|
|
15220
|
+
exports.QuerySuggestionsApiFactory = QuerySuggestionsApiFactory;
|
|
15221
|
+
/**
|
|
15222
|
+
* QuerySuggestionsApi - object-oriented interface
|
|
15223
|
+
* @export
|
|
15224
|
+
* @class QuerySuggestionsApi
|
|
15225
|
+
* @extends {BaseAPI}
|
|
15226
|
+
*/
|
|
15227
|
+
class QuerySuggestionsApi extends base_1.BaseAPI {
|
|
15228
|
+
/**
|
|
15229
|
+
* Retrieve configuration settings for query suggestions API including limits, supported time ranges, and default values
|
|
15230
|
+
* @summary Get Query Suggestions Configuration
|
|
15231
|
+
* @param {string} xStoreid Store ID
|
|
15232
|
+
* @param {string} xStoresecret Store Secret
|
|
15233
|
+
* @param {*} [options] Override http request option.
|
|
15234
|
+
* @throws {RequiredError}
|
|
15235
|
+
* @memberof QuerySuggestionsApi
|
|
15236
|
+
*/
|
|
15237
|
+
v1SuggestionsConfigGet(xStoreid, xStoresecret, options) {
|
|
15238
|
+
return (0, exports.QuerySuggestionsApiFp)(this.configuration).v1SuggestionsConfigGet(xStoreid, xStoresecret, options).then((request) => request(this.axios, this.basePath));
|
|
15239
|
+
}
|
|
15240
|
+
/**
|
|
15241
|
+
* Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering, and configurable time ranges.
|
|
15242
|
+
* @summary Get Query Suggestions
|
|
15243
|
+
* @param {string} xStoreid Store ID
|
|
15244
|
+
* @param {string} xStoresecret Store Secret
|
|
15245
|
+
* @param {string} [query] Partial query to get suggestions for
|
|
15246
|
+
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
15247
|
+
* @param {number} [page] Page number for pagination
|
|
15248
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
|
|
15249
|
+
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
|
|
15250
|
+
* @param {boolean} [includeCategories] Include category information in suggestions
|
|
15251
|
+
* @param {boolean} [includeFacets] Include popular facets/filters information
|
|
15252
|
+
* @param {number} [maxCategories] Maximum categories per suggestion
|
|
15253
|
+
* @param {number} [maxFacets] Maximum facets per suggestion
|
|
15254
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
15255
|
+
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
|
|
15256
|
+
* @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
|
|
15257
|
+
* @param {*} [options] Override http request option.
|
|
15258
|
+
* @throws {RequiredError}
|
|
15259
|
+
* @memberof QuerySuggestionsApi
|
|
15260
|
+
*/
|
|
15261
|
+
v1SuggestionsQueriesGet(xStoreid, xStoresecret, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options) {
|
|
15262
|
+
return (0, exports.QuerySuggestionsApiFp)(this.configuration).v1SuggestionsQueriesGet(xStoreid, xStoresecret, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options).then((request) => request(this.axios, this.basePath));
|
|
15263
|
+
}
|
|
15264
|
+
}
|
|
15265
|
+
exports.QuerySuggestionsApi = QuerySuggestionsApi;
|
|
15266
|
+
/**
|
|
15267
|
+
* @export
|
|
15268
|
+
*/
|
|
15269
|
+
exports.V1SuggestionsQueriesGetTagsMatchModeEnum = {
|
|
15270
|
+
Any: 'any',
|
|
15271
|
+
All: 'all'
|
|
15272
|
+
};
|
|
15273
|
+
/**
|
|
15274
|
+
* @export
|
|
15275
|
+
*/
|
|
15276
|
+
exports.V1SuggestionsQueriesGetTimeRangeEnum = {
|
|
15277
|
+
_7d: '7d',
|
|
15278
|
+
_30d: '30d',
|
|
15279
|
+
_90d: '90d'
|
|
15280
|
+
};
|
|
15281
|
+
/**
|
|
15282
|
+
* QuerySuggestionsManagementApi - axios parameter creator
|
|
15283
|
+
* @export
|
|
15284
|
+
*/
|
|
15285
|
+
const QuerySuggestionsManagementApiAxiosParamCreator = function (configuration) {
|
|
15286
|
+
return {
|
|
15287
|
+
/**
|
|
15288
|
+
* Migrate existing analytics data for all stores (admin only)
|
|
15289
|
+
* @summary Migrate All Stores Data
|
|
15290
|
+
* @param {number} [daysBack] Number of days back to migrate data
|
|
15291
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
15292
|
+
* @param {*} [options] Override http request option.
|
|
15293
|
+
* @throws {RequiredError}
|
|
15294
|
+
*/
|
|
15295
|
+
adminAnalyticsQuerySuggestionsMigrateAllPost: (daysBack_1, minPopularity_1, ...args_1) => __awaiter(this, [daysBack_1, minPopularity_1, ...args_1], void 0, function* (daysBack, minPopularity, options = {}) {
|
|
15296
|
+
const localVarPath = `/admin/analytics/query-suggestions/migrate-all`;
|
|
15297
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15298
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
15299
|
+
let baseOptions;
|
|
15300
|
+
if (configuration) {
|
|
15301
|
+
baseOptions = configuration.baseOptions;
|
|
15302
|
+
}
|
|
15303
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
15304
|
+
const localVarHeaderParameter = {};
|
|
15305
|
+
const localVarQueryParameter = {};
|
|
15306
|
+
// authentication BearerAuth required
|
|
15307
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
15308
|
+
if (daysBack !== undefined) {
|
|
15309
|
+
localVarQueryParameter['days_back'] = daysBack;
|
|
15310
|
+
}
|
|
15311
|
+
if (minPopularity !== undefined) {
|
|
15312
|
+
localVarQueryParameter['min_popularity'] = minPopularity;
|
|
15313
|
+
}
|
|
15314
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
15315
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15316
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15317
|
+
return {
|
|
15318
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
15319
|
+
options: localVarRequestOptions,
|
|
15320
|
+
};
|
|
15321
|
+
}),
|
|
15322
|
+
/**
|
|
15323
|
+
* Perform bulk operations on multiple suggestions (enable, disable, delete, update priority)
|
|
15324
|
+
* @summary Bulk Update Suggestions
|
|
15325
|
+
* @param {string} xStoreID Store ID
|
|
15326
|
+
* @param {AnalyticsBulkOperationRequest} body Bulk operation request
|
|
15327
|
+
* @param {*} [options] Override http request option.
|
|
15328
|
+
* @throws {RequiredError}
|
|
15329
|
+
*/
|
|
15330
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsBulkPost: (xStoreID_1, body_1, ...args_1) => __awaiter(this, [xStoreID_1, body_1, ...args_1], void 0, function* (xStoreID, body, options = {}) {
|
|
15331
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
15332
|
+
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQuerySuggestionsBulkPost', 'xStoreID', xStoreID);
|
|
15333
|
+
// verify required parameter 'body' is not null or undefined
|
|
15334
|
+
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQuerySuggestionsBulkPost', 'body', body);
|
|
15335
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/query-suggestions/bulk`
|
|
15336
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
15337
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15338
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
15339
|
+
let baseOptions;
|
|
15340
|
+
if (configuration) {
|
|
15341
|
+
baseOptions = configuration.baseOptions;
|
|
15342
|
+
}
|
|
15343
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
15344
|
+
const localVarHeaderParameter = {};
|
|
15345
|
+
const localVarQueryParameter = {};
|
|
15346
|
+
// authentication BearerAuth required
|
|
15347
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
15348
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
15349
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
15350
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15351
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15352
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
|
|
15353
|
+
return {
|
|
15354
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
15355
|
+
options: localVarRequestOptions,
|
|
15356
|
+
};
|
|
15357
|
+
}),
|
|
15358
|
+
/**
|
|
15359
|
+
* Retrieve auto-generated suggestions from cache for review before promoting to management table
|
|
15360
|
+
* @summary Get Cached Auto-Generated Suggestions
|
|
15361
|
+
* @param {string} xStoreID Store ID
|
|
15362
|
+
* @param {number} [page] Page number
|
|
15363
|
+
* @param {number} [pageSize] Items per page
|
|
15364
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
15365
|
+
* @param {*} [options] Override http request option.
|
|
15366
|
+
* @throws {RequiredError}
|
|
15367
|
+
*/
|
|
15368
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsCachedGet: (xStoreID_1, page_1, pageSize_1, minPopularity_1, ...args_1) => __awaiter(this, [xStoreID_1, page_1, pageSize_1, minPopularity_1, ...args_1], void 0, function* (xStoreID, page, pageSize, minPopularity, options = {}) {
|
|
15369
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
15370
|
+
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQuerySuggestionsCachedGet', 'xStoreID', xStoreID);
|
|
15371
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/query-suggestions/cached`
|
|
15372
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
15373
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15374
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
15375
|
+
let baseOptions;
|
|
15376
|
+
if (configuration) {
|
|
15377
|
+
baseOptions = configuration.baseOptions;
|
|
15378
|
+
}
|
|
15379
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
15380
|
+
const localVarHeaderParameter = {};
|
|
15381
|
+
const localVarQueryParameter = {};
|
|
15382
|
+
// authentication BearerAuth required
|
|
15383
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
15384
|
+
if (page !== undefined) {
|
|
15385
|
+
localVarQueryParameter['page'] = page;
|
|
15386
|
+
}
|
|
15387
|
+
if (pageSize !== undefined) {
|
|
15388
|
+
localVarQueryParameter['page_size'] = pageSize;
|
|
15389
|
+
}
|
|
15390
|
+
if (minPopularity !== undefined) {
|
|
15391
|
+
localVarQueryParameter['min_popularity'] = minPopularity;
|
|
15392
|
+
}
|
|
15393
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
15394
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15395
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15396
|
+
return {
|
|
15397
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
15398
|
+
options: localVarRequestOptions,
|
|
15399
|
+
};
|
|
15400
|
+
}),
|
|
15401
|
+
/**
|
|
15402
|
+
* Retrieve query suggestions with filtering and pagination for management
|
|
15403
|
+
* @summary Get Query Suggestions
|
|
15404
|
+
* @param {string} xStoreID Store ID
|
|
15405
|
+
* @param {string} [source] Filter by source (auto_generated, manual, imported)
|
|
15406
|
+
* @param {string} [status] Filter by status (enabled, disabled)
|
|
15407
|
+
* @param {string} [query] Search within query text
|
|
15408
|
+
* @param {string} [category] Filter by category
|
|
15409
|
+
* @param {string} [tag] Filter by tag
|
|
15410
|
+
* @param {number} [page] Page number
|
|
15411
|
+
* @param {number} [pageSize] Number of items per page
|
|
15412
|
+
* @param {*} [options] Override http request option.
|
|
15413
|
+
* @throws {RequiredError}
|
|
15414
|
+
*/
|
|
15415
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsGet: (xStoreID_1, source_1, status_1, query_1, category_1, tag_1, page_1, pageSize_1, ...args_1) => __awaiter(this, [xStoreID_1, source_1, status_1, query_1, category_1, tag_1, page_1, pageSize_1, ...args_1], void 0, function* (xStoreID, source, status, query, category, tag, page, pageSize, options = {}) {
|
|
15416
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
15417
|
+
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQuerySuggestionsGet', 'xStoreID', xStoreID);
|
|
15418
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/query-suggestions`
|
|
15419
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
15420
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15421
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
15422
|
+
let baseOptions;
|
|
15423
|
+
if (configuration) {
|
|
15424
|
+
baseOptions = configuration.baseOptions;
|
|
15425
|
+
}
|
|
15426
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
15427
|
+
const localVarHeaderParameter = {};
|
|
15428
|
+
const localVarQueryParameter = {};
|
|
15429
|
+
// authentication BearerAuth required
|
|
15430
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
15431
|
+
if (source !== undefined) {
|
|
15432
|
+
localVarQueryParameter['source'] = source;
|
|
15433
|
+
}
|
|
15434
|
+
if (status !== undefined) {
|
|
15435
|
+
localVarQueryParameter['status'] = status;
|
|
15436
|
+
}
|
|
15437
|
+
if (query !== undefined) {
|
|
15438
|
+
localVarQueryParameter['query'] = query;
|
|
15439
|
+
}
|
|
15440
|
+
if (category !== undefined) {
|
|
15441
|
+
localVarQueryParameter['category'] = category;
|
|
15442
|
+
}
|
|
15443
|
+
if (tag !== undefined) {
|
|
15444
|
+
localVarQueryParameter['tag'] = tag;
|
|
15445
|
+
}
|
|
15446
|
+
if (page !== undefined) {
|
|
15447
|
+
localVarQueryParameter['page'] = page;
|
|
15448
|
+
}
|
|
15449
|
+
if (pageSize !== undefined) {
|
|
15450
|
+
localVarQueryParameter['page_size'] = pageSize;
|
|
15451
|
+
}
|
|
15452
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
15453
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15454
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15455
|
+
return {
|
|
15456
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
15457
|
+
options: localVarRequestOptions,
|
|
15458
|
+
};
|
|
15459
|
+
}),
|
|
15460
|
+
/**
|
|
15461
|
+
* Import query suggestions from JSON data
|
|
15462
|
+
* @summary Import Query Suggestions
|
|
15463
|
+
* @param {string} xStoreID Store ID
|
|
15464
|
+
* @param {AnalyticsImportQuerySuggestionsRequest} body Import suggestions request
|
|
15465
|
+
* @param {*} [options] Override http request option.
|
|
15466
|
+
* @throws {RequiredError}
|
|
15467
|
+
*/
|
|
15468
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsImportPost: (xStoreID_1, body_1, ...args_1) => __awaiter(this, [xStoreID_1, body_1, ...args_1], void 0, function* (xStoreID, body, options = {}) {
|
|
15469
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
15470
|
+
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQuerySuggestionsImportPost', 'xStoreID', xStoreID);
|
|
15471
|
+
// verify required parameter 'body' is not null or undefined
|
|
15472
|
+
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQuerySuggestionsImportPost', 'body', body);
|
|
15473
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/query-suggestions/import`
|
|
15474
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
15475
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15476
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
15477
|
+
let baseOptions;
|
|
15478
|
+
if (configuration) {
|
|
15479
|
+
baseOptions = configuration.baseOptions;
|
|
15480
|
+
}
|
|
15481
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
15482
|
+
const localVarHeaderParameter = {};
|
|
15483
|
+
const localVarQueryParameter = {};
|
|
15484
|
+
// authentication BearerAuth required
|
|
15485
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
15486
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
15487
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
15488
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15489
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15490
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
|
|
15491
|
+
return {
|
|
15492
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
15493
|
+
options: localVarRequestOptions,
|
|
15494
|
+
};
|
|
15495
|
+
}),
|
|
15496
|
+
/**
|
|
15497
|
+
* Add a manually created query suggestion for a store
|
|
15498
|
+
* @summary Add Manual Query Suggestion
|
|
15499
|
+
* @param {string} xStoreID Store ID
|
|
15500
|
+
* @param {AnalyticsManualQuerySuggestionRequest} body Manual suggestion request
|
|
15501
|
+
* @param {*} [options] Override http request option.
|
|
15502
|
+
* @throws {RequiredError}
|
|
15503
|
+
*/
|
|
15504
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsManualPost: (xStoreID_1, body_1, ...args_1) => __awaiter(this, [xStoreID_1, body_1, ...args_1], void 0, function* (xStoreID, body, options = {}) {
|
|
15505
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
15506
|
+
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQuerySuggestionsManualPost', 'xStoreID', xStoreID);
|
|
15507
|
+
// verify required parameter 'body' is not null or undefined
|
|
15508
|
+
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQuerySuggestionsManualPost', 'body', body);
|
|
15509
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/query-suggestions/manual`
|
|
15510
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
15511
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15512
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
15513
|
+
let baseOptions;
|
|
15514
|
+
if (configuration) {
|
|
15515
|
+
baseOptions = configuration.baseOptions;
|
|
15516
|
+
}
|
|
15517
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
15518
|
+
const localVarHeaderParameter = {};
|
|
15519
|
+
const localVarQueryParameter = {};
|
|
15520
|
+
// authentication BearerAuth required
|
|
15521
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
15522
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
15523
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
15524
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15525
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15526
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
|
|
15527
|
+
return {
|
|
15528
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
15529
|
+
options: localVarRequestOptions,
|
|
15530
|
+
};
|
|
15531
|
+
}),
|
|
15532
|
+
/**
|
|
15533
|
+
* Migrate existing search analytics data to the new query suggestions management system
|
|
15534
|
+
* @summary Migrate Existing Analytics Data
|
|
15535
|
+
* @param {string} xStoreID Store ID
|
|
15536
|
+
* @param {number} [daysBack] Number of days back to migrate data
|
|
15537
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
15538
|
+
* @param {*} [options] Override http request option.
|
|
15539
|
+
* @throws {RequiredError}
|
|
15540
|
+
*/
|
|
15541
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsMigratePost: (xStoreID_1, daysBack_1, minPopularity_1, ...args_1) => __awaiter(this, [xStoreID_1, daysBack_1, minPopularity_1, ...args_1], void 0, function* (xStoreID, daysBack, minPopularity, options = {}) {
|
|
15542
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
15543
|
+
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQuerySuggestionsMigratePost', 'xStoreID', xStoreID);
|
|
15544
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/query-suggestions/migrate`
|
|
15545
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
15546
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15547
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
15548
|
+
let baseOptions;
|
|
15549
|
+
if (configuration) {
|
|
15550
|
+
baseOptions = configuration.baseOptions;
|
|
15551
|
+
}
|
|
15552
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
15553
|
+
const localVarHeaderParameter = {};
|
|
15554
|
+
const localVarQueryParameter = {};
|
|
15555
|
+
// authentication BearerAuth required
|
|
15556
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
15557
|
+
if (daysBack !== undefined) {
|
|
15558
|
+
localVarQueryParameter['days_back'] = daysBack;
|
|
15559
|
+
}
|
|
15560
|
+
if (minPopularity !== undefined) {
|
|
15561
|
+
localVarQueryParameter['min_popularity'] = minPopularity;
|
|
15562
|
+
}
|
|
15563
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
15564
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15565
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15566
|
+
return {
|
|
15567
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
15568
|
+
options: localVarRequestOptions,
|
|
15569
|
+
};
|
|
15570
|
+
}),
|
|
15571
|
+
/**
|
|
15572
|
+
* Move ALL auto-generated suggestions from cache to the management table that meet minimum popularity criteria
|
|
15573
|
+
* @summary Promote ALL Cached Suggestions to Management Table
|
|
15574
|
+
* @param {string} xStoreID Store ID
|
|
15575
|
+
* @param {number} [minPopularity] Minimum popularity threshold (default: 5)
|
|
15576
|
+
* @param {*} [options] Override http request option.
|
|
15577
|
+
* @throws {RequiredError}
|
|
15578
|
+
*/
|
|
15579
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsPromoteAllPost: (xStoreID_1, minPopularity_1, ...args_1) => __awaiter(this, [xStoreID_1, minPopularity_1, ...args_1], void 0, function* (xStoreID, minPopularity, options = {}) {
|
|
15580
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
15581
|
+
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQuerySuggestionsPromoteAllPost', 'xStoreID', xStoreID);
|
|
15582
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/query-suggestions/promote-all`
|
|
15583
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
15584
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15585
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
15586
|
+
let baseOptions;
|
|
15587
|
+
if (configuration) {
|
|
15588
|
+
baseOptions = configuration.baseOptions;
|
|
15589
|
+
}
|
|
15590
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
15591
|
+
const localVarHeaderParameter = {};
|
|
15592
|
+
const localVarQueryParameter = {};
|
|
15593
|
+
// authentication BearerAuth required
|
|
15594
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
15595
|
+
if (minPopularity !== undefined) {
|
|
15596
|
+
localVarQueryParameter['min_popularity'] = minPopularity;
|
|
15597
|
+
}
|
|
15598
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
15599
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15600
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15601
|
+
return {
|
|
15602
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
15603
|
+
options: localVarRequestOptions,
|
|
15604
|
+
};
|
|
15605
|
+
}),
|
|
15606
|
+
/**
|
|
15607
|
+
* Move selected auto-generated suggestions from cache to the management table
|
|
15608
|
+
* @summary Promote Cached Suggestions to Management Table
|
|
15609
|
+
* @param {string} xStoreID Store ID
|
|
15610
|
+
* @param {AnalyticsPromoteSuggestionsRequest} body Promotion request
|
|
15611
|
+
* @param {*} [options] Override http request option.
|
|
15612
|
+
* @throws {RequiredError}
|
|
15613
|
+
*/
|
|
15614
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsPromotePost: (xStoreID_1, body_1, ...args_1) => __awaiter(this, [xStoreID_1, body_1, ...args_1], void 0, function* (xStoreID, body, options = {}) {
|
|
15615
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
15616
|
+
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQuerySuggestionsPromotePost', 'xStoreID', xStoreID);
|
|
15617
|
+
// verify required parameter 'body' is not null or undefined
|
|
15618
|
+
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQuerySuggestionsPromotePost', 'body', body);
|
|
15619
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/query-suggestions/promote`
|
|
15620
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
15621
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15622
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
15623
|
+
let baseOptions;
|
|
15624
|
+
if (configuration) {
|
|
15625
|
+
baseOptions = configuration.baseOptions;
|
|
15626
|
+
}
|
|
15627
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
15628
|
+
const localVarHeaderParameter = {};
|
|
15629
|
+
const localVarQueryParameter = {};
|
|
15630
|
+
// authentication BearerAuth required
|
|
15631
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
15632
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
15633
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
15634
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15635
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15636
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
|
|
15637
|
+
return {
|
|
15638
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
15639
|
+
options: localVarRequestOptions,
|
|
15640
|
+
};
|
|
15641
|
+
}),
|
|
15642
|
+
/**
|
|
15643
|
+
* Refresh auto-generated suggestions from search analytics data
|
|
15644
|
+
* @summary Refresh Auto-Generated Suggestions
|
|
15645
|
+
* @param {string} xStoreID Store ID
|
|
15646
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
15647
|
+
* @param {number} [days] Number of days to analyze
|
|
15648
|
+
* @param {*} [options] Override http request option.
|
|
15649
|
+
* @throws {RequiredError}
|
|
15650
|
+
*/
|
|
15651
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsRefreshPost: (xStoreID_1, minPopularity_1, days_1, ...args_1) => __awaiter(this, [xStoreID_1, minPopularity_1, days_1, ...args_1], void 0, function* (xStoreID, minPopularity, days, options = {}) {
|
|
15652
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
15653
|
+
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQuerySuggestionsRefreshPost', 'xStoreID', xStoreID);
|
|
15654
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/query-suggestions/refresh`
|
|
15655
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
15656
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15657
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
15658
|
+
let baseOptions;
|
|
15659
|
+
if (configuration) {
|
|
15660
|
+
baseOptions = configuration.baseOptions;
|
|
15661
|
+
}
|
|
15662
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
15663
|
+
const localVarHeaderParameter = {};
|
|
15664
|
+
const localVarQueryParameter = {};
|
|
15665
|
+
// authentication BearerAuth required
|
|
15666
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
15667
|
+
if (minPopularity !== undefined) {
|
|
15668
|
+
localVarQueryParameter['min_popularity'] = minPopularity;
|
|
15669
|
+
}
|
|
15670
|
+
if (days !== undefined) {
|
|
15671
|
+
localVarQueryParameter['days'] = days;
|
|
15672
|
+
}
|
|
15673
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
15674
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15675
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15676
|
+
return {
|
|
15677
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
15678
|
+
options: localVarRequestOptions,
|
|
15679
|
+
};
|
|
15680
|
+
}),
|
|
15681
|
+
/**
|
|
15682
|
+
* Get statistics about query suggestions for a store
|
|
15683
|
+
* @summary Get Suggestion Statistics
|
|
15684
|
+
* @param {string} xStoreID Store ID
|
|
15685
|
+
* @param {*} [options] Override http request option.
|
|
15686
|
+
* @throws {RequiredError}
|
|
15687
|
+
*/
|
|
15688
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsStatsGet: (xStoreID_1, ...args_1) => __awaiter(this, [xStoreID_1, ...args_1], void 0, function* (xStoreID, options = {}) {
|
|
15689
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
15690
|
+
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQuerySuggestionsStatsGet', 'xStoreID', xStoreID);
|
|
15691
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/query-suggestions/stats`
|
|
15692
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
15693
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15694
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
15695
|
+
let baseOptions;
|
|
15696
|
+
if (configuration) {
|
|
15697
|
+
baseOptions = configuration.baseOptions;
|
|
15698
|
+
}
|
|
15699
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
15700
|
+
const localVarHeaderParameter = {};
|
|
15701
|
+
const localVarQueryParameter = {};
|
|
15702
|
+
// authentication BearerAuth required
|
|
15703
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
15704
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
15705
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15706
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15707
|
+
return {
|
|
15708
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
15709
|
+
options: localVarRequestOptions,
|
|
15710
|
+
};
|
|
15711
|
+
}),
|
|
15712
|
+
/**
|
|
15713
|
+
* Update the status (enabled/disabled) of a query suggestion
|
|
15714
|
+
* @summary Update Suggestion Status
|
|
15715
|
+
* @param {string} xStoreID Store ID
|
|
15716
|
+
* @param {string} suggestionID Suggestion ID
|
|
15717
|
+
* @param {string} status New status (enabled, disabled)
|
|
15718
|
+
* @param {*} [options] Override http request option.
|
|
15719
|
+
* @throws {RequiredError}
|
|
15720
|
+
*/
|
|
15721
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsSuggestionIDStatusPut: (xStoreID_1, suggestionID_1, status_1, ...args_1) => __awaiter(this, [xStoreID_1, suggestionID_1, status_1, ...args_1], void 0, function* (xStoreID, suggestionID, status, options = {}) {
|
|
15722
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
15723
|
+
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQuerySuggestionsSuggestionIDStatusPut', 'xStoreID', xStoreID);
|
|
15724
|
+
// verify required parameter 'suggestionID' is not null or undefined
|
|
15725
|
+
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQuerySuggestionsSuggestionIDStatusPut', 'suggestionID', suggestionID);
|
|
15726
|
+
// verify required parameter 'status' is not null or undefined
|
|
15727
|
+
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQuerySuggestionsSuggestionIDStatusPut', 'status', status);
|
|
15728
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/query-suggestions/{suggestionID}/status`
|
|
15729
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)))
|
|
15730
|
+
.replace(`{${"suggestionID"}}`, encodeURIComponent(String(suggestionID)));
|
|
15731
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15732
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
15733
|
+
let baseOptions;
|
|
15734
|
+
if (configuration) {
|
|
15735
|
+
baseOptions = configuration.baseOptions;
|
|
15736
|
+
}
|
|
15737
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
15738
|
+
const localVarHeaderParameter = {};
|
|
15739
|
+
const localVarQueryParameter = {};
|
|
15740
|
+
// authentication BearerAuth required
|
|
15741
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
15742
|
+
if (status !== undefined) {
|
|
15743
|
+
localVarQueryParameter['status'] = status;
|
|
15744
|
+
}
|
|
15745
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
15746
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15747
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15748
|
+
return {
|
|
15749
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
15750
|
+
options: localVarRequestOptions,
|
|
15751
|
+
};
|
|
15752
|
+
}),
|
|
15753
|
+
/**
|
|
15754
|
+
* Sync enabled query suggestions to Typesense collection for public API usage
|
|
15755
|
+
* @summary Sync Suggestions to Typesense
|
|
15756
|
+
* @param {string} xStoreID Store ID
|
|
15757
|
+
* @param {*} [options] Override http request option.
|
|
15758
|
+
* @throws {RequiredError}
|
|
15759
|
+
*/
|
|
15760
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsSyncPost: (xStoreID_1, ...args_1) => __awaiter(this, [xStoreID_1, ...args_1], void 0, function* (xStoreID, options = {}) {
|
|
15761
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
15762
|
+
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQuerySuggestionsSyncPost', 'xStoreID', xStoreID);
|
|
15763
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/query-suggestions/sync`
|
|
15764
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
15765
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15766
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
15767
|
+
let baseOptions;
|
|
15768
|
+
if (configuration) {
|
|
15769
|
+
baseOptions = configuration.baseOptions;
|
|
15770
|
+
}
|
|
15771
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
15772
|
+
const localVarHeaderParameter = {};
|
|
15773
|
+
const localVarQueryParameter = {};
|
|
15774
|
+
// authentication BearerAuth required
|
|
15775
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
15776
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
15777
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15778
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15779
|
+
return {
|
|
15780
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
15781
|
+
options: localVarRequestOptions,
|
|
15782
|
+
};
|
|
15783
|
+
}),
|
|
15784
|
+
/**
|
|
15785
|
+
* Retrieve query suggestions directly from Typesense collection for admin dashboard testing/viewing
|
|
15786
|
+
* @summary Get Query Suggestions from Typesense (Admin)
|
|
15787
|
+
* @param {string} xStoreID Store ID
|
|
15788
|
+
* @param {string} [query] Partial query to get suggestions for
|
|
15789
|
+
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
15790
|
+
* @param {number} [page] Page number for pagination
|
|
15791
|
+
* @param {*} [options] Override http request option.
|
|
15792
|
+
* @throws {RequiredError}
|
|
15793
|
+
*/
|
|
15794
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsTypesenseGet: (xStoreID_1, query_1, hitsPerPage_1, page_1, ...args_1) => __awaiter(this, [xStoreID_1, query_1, hitsPerPage_1, page_1, ...args_1], void 0, function* (xStoreID, query, hitsPerPage, page, options = {}) {
|
|
15795
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
15796
|
+
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQuerySuggestionsTypesenseGet', 'xStoreID', xStoreID);
|
|
15797
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/query-suggestions/typesense`
|
|
15798
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
15799
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15800
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
15801
|
+
let baseOptions;
|
|
15802
|
+
if (configuration) {
|
|
15803
|
+
baseOptions = configuration.baseOptions;
|
|
15804
|
+
}
|
|
15805
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
15806
|
+
const localVarHeaderParameter = {};
|
|
15807
|
+
const localVarQueryParameter = {};
|
|
15808
|
+
// authentication BearerAuth required
|
|
15809
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
15810
|
+
if (query !== undefined) {
|
|
15811
|
+
localVarQueryParameter['query'] = query;
|
|
15812
|
+
}
|
|
15813
|
+
if (hitsPerPage !== undefined) {
|
|
15814
|
+
localVarQueryParameter['hitsPerPage'] = hitsPerPage;
|
|
15815
|
+
}
|
|
15816
|
+
if (page !== undefined) {
|
|
15817
|
+
localVarQueryParameter['page'] = page;
|
|
15818
|
+
}
|
|
15819
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
15820
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15821
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15822
|
+
return {
|
|
15823
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
15824
|
+
options: localVarRequestOptions,
|
|
15825
|
+
};
|
|
15826
|
+
}),
|
|
15827
|
+
};
|
|
15828
|
+
};
|
|
15829
|
+
exports.QuerySuggestionsManagementApiAxiosParamCreator = QuerySuggestionsManagementApiAxiosParamCreator;
|
|
15830
|
+
/**
|
|
15831
|
+
* QuerySuggestionsManagementApi - functional programming interface
|
|
15832
|
+
* @export
|
|
15833
|
+
*/
|
|
15834
|
+
const QuerySuggestionsManagementApiFp = function (configuration) {
|
|
15835
|
+
const localVarAxiosParamCreator = (0, exports.QuerySuggestionsManagementApiAxiosParamCreator)(configuration);
|
|
15836
|
+
return {
|
|
15837
|
+
/**
|
|
15838
|
+
* Migrate existing analytics data for all stores (admin only)
|
|
15839
|
+
* @summary Migrate All Stores Data
|
|
15840
|
+
* @param {number} [daysBack] Number of days back to migrate data
|
|
15841
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
15842
|
+
* @param {*} [options] Override http request option.
|
|
15843
|
+
* @throws {RequiredError}
|
|
15844
|
+
*/
|
|
15845
|
+
adminAnalyticsQuerySuggestionsMigrateAllPost(daysBack, minPopularity, options) {
|
|
15846
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15847
|
+
var _a, _b, _c;
|
|
15848
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsQuerySuggestionsMigrateAllPost(daysBack, minPopularity, options);
|
|
15849
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15850
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsQuerySuggestionsMigrateAllPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15851
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15852
|
+
});
|
|
15853
|
+
},
|
|
15854
|
+
/**
|
|
15855
|
+
* Perform bulk operations on multiple suggestions (enable, disable, delete, update priority)
|
|
15856
|
+
* @summary Bulk Update Suggestions
|
|
15857
|
+
* @param {string} xStoreID Store ID
|
|
15858
|
+
* @param {AnalyticsBulkOperationRequest} body Bulk operation request
|
|
15859
|
+
* @param {*} [options] Override http request option.
|
|
15860
|
+
* @throws {RequiredError}
|
|
15861
|
+
*/
|
|
15862
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsBulkPost(xStoreID, body, options) {
|
|
15863
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15864
|
+
var _a, _b, _c;
|
|
15865
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQuerySuggestionsBulkPost(xStoreID, body, options);
|
|
15866
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15867
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsStoreXStoreIDQuerySuggestionsBulkPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15868
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15869
|
+
});
|
|
15870
|
+
},
|
|
15871
|
+
/**
|
|
15872
|
+
* Retrieve auto-generated suggestions from cache for review before promoting to management table
|
|
15873
|
+
* @summary Get Cached Auto-Generated Suggestions
|
|
15874
|
+
* @param {string} xStoreID Store ID
|
|
15875
|
+
* @param {number} [page] Page number
|
|
15876
|
+
* @param {number} [pageSize] Items per page
|
|
15877
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
15878
|
+
* @param {*} [options] Override http request option.
|
|
15879
|
+
* @throws {RequiredError}
|
|
15880
|
+
*/
|
|
15881
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsCachedGet(xStoreID, page, pageSize, minPopularity, options) {
|
|
15882
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15883
|
+
var _a, _b, _c;
|
|
15884
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQuerySuggestionsCachedGet(xStoreID, page, pageSize, minPopularity, options);
|
|
15885
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15886
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsStoreXStoreIDQuerySuggestionsCachedGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15887
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15888
|
+
});
|
|
15889
|
+
},
|
|
15890
|
+
/**
|
|
15891
|
+
* Retrieve query suggestions with filtering and pagination for management
|
|
15892
|
+
* @summary Get Query Suggestions
|
|
15893
|
+
* @param {string} xStoreID Store ID
|
|
15894
|
+
* @param {string} [source] Filter by source (auto_generated, manual, imported)
|
|
15895
|
+
* @param {string} [status] Filter by status (enabled, disabled)
|
|
15896
|
+
* @param {string} [query] Search within query text
|
|
15897
|
+
* @param {string} [category] Filter by category
|
|
15898
|
+
* @param {string} [tag] Filter by tag
|
|
15899
|
+
* @param {number} [page] Page number
|
|
15900
|
+
* @param {number} [pageSize] Number of items per page
|
|
15901
|
+
* @param {*} [options] Override http request option.
|
|
15902
|
+
* @throws {RequiredError}
|
|
15903
|
+
*/
|
|
15904
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsGet(xStoreID, source, status, query, category, tag, page, pageSize, options) {
|
|
15905
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15906
|
+
var _a, _b, _c;
|
|
15907
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQuerySuggestionsGet(xStoreID, source, status, query, category, tag, page, pageSize, options);
|
|
15908
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15909
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsStoreXStoreIDQuerySuggestionsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15910
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15911
|
+
});
|
|
15912
|
+
},
|
|
15913
|
+
/**
|
|
15914
|
+
* Import query suggestions from JSON data
|
|
15915
|
+
* @summary Import Query Suggestions
|
|
15916
|
+
* @param {string} xStoreID Store ID
|
|
15917
|
+
* @param {AnalyticsImportQuerySuggestionsRequest} body Import suggestions request
|
|
15918
|
+
* @param {*} [options] Override http request option.
|
|
15919
|
+
* @throws {RequiredError}
|
|
15920
|
+
*/
|
|
15921
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsImportPost(xStoreID, body, options) {
|
|
15922
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15923
|
+
var _a, _b, _c;
|
|
15924
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQuerySuggestionsImportPost(xStoreID, body, options);
|
|
15925
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15926
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsStoreXStoreIDQuerySuggestionsImportPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15927
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15928
|
+
});
|
|
15929
|
+
},
|
|
15930
|
+
/**
|
|
15931
|
+
* Add a manually created query suggestion for a store
|
|
15932
|
+
* @summary Add Manual Query Suggestion
|
|
15933
|
+
* @param {string} xStoreID Store ID
|
|
15934
|
+
* @param {AnalyticsManualQuerySuggestionRequest} body Manual suggestion request
|
|
15935
|
+
* @param {*} [options] Override http request option.
|
|
15936
|
+
* @throws {RequiredError}
|
|
15937
|
+
*/
|
|
15938
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsManualPost(xStoreID, body, options) {
|
|
15939
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15940
|
+
var _a, _b, _c;
|
|
15941
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQuerySuggestionsManualPost(xStoreID, body, options);
|
|
15942
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15943
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsStoreXStoreIDQuerySuggestionsManualPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15944
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15945
|
+
});
|
|
15946
|
+
},
|
|
15947
|
+
/**
|
|
15948
|
+
* Migrate existing search analytics data to the new query suggestions management system
|
|
15949
|
+
* @summary Migrate Existing Analytics Data
|
|
15950
|
+
* @param {string} xStoreID Store ID
|
|
15951
|
+
* @param {number} [daysBack] Number of days back to migrate data
|
|
15952
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
15953
|
+
* @param {*} [options] Override http request option.
|
|
15954
|
+
* @throws {RequiredError}
|
|
15955
|
+
*/
|
|
15956
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsMigratePost(xStoreID, daysBack, minPopularity, options) {
|
|
15957
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15958
|
+
var _a, _b, _c;
|
|
15959
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQuerySuggestionsMigratePost(xStoreID, daysBack, minPopularity, options);
|
|
15960
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15961
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsStoreXStoreIDQuerySuggestionsMigratePost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15962
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15963
|
+
});
|
|
15964
|
+
},
|
|
15965
|
+
/**
|
|
15966
|
+
* Move ALL auto-generated suggestions from cache to the management table that meet minimum popularity criteria
|
|
15967
|
+
* @summary Promote ALL Cached Suggestions to Management Table
|
|
15968
|
+
* @param {string} xStoreID Store ID
|
|
15969
|
+
* @param {number} [minPopularity] Minimum popularity threshold (default: 5)
|
|
15970
|
+
* @param {*} [options] Override http request option.
|
|
15971
|
+
* @throws {RequiredError}
|
|
15972
|
+
*/
|
|
15973
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsPromoteAllPost(xStoreID, minPopularity, options) {
|
|
15974
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15975
|
+
var _a, _b, _c;
|
|
15976
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQuerySuggestionsPromoteAllPost(xStoreID, minPopularity, options);
|
|
15977
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15978
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsStoreXStoreIDQuerySuggestionsPromoteAllPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15979
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15980
|
+
});
|
|
15981
|
+
},
|
|
15982
|
+
/**
|
|
15983
|
+
* Move selected auto-generated suggestions from cache to the management table
|
|
15984
|
+
* @summary Promote Cached Suggestions to Management Table
|
|
15985
|
+
* @param {string} xStoreID Store ID
|
|
15986
|
+
* @param {AnalyticsPromoteSuggestionsRequest} body Promotion request
|
|
15987
|
+
* @param {*} [options] Override http request option.
|
|
15988
|
+
* @throws {RequiredError}
|
|
15989
|
+
*/
|
|
15990
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsPromotePost(xStoreID, body, options) {
|
|
15991
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15992
|
+
var _a, _b, _c;
|
|
15993
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQuerySuggestionsPromotePost(xStoreID, body, options);
|
|
15994
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15995
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsStoreXStoreIDQuerySuggestionsPromotePost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15996
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15997
|
+
});
|
|
15998
|
+
},
|
|
15999
|
+
/**
|
|
16000
|
+
* Refresh auto-generated suggestions from search analytics data
|
|
16001
|
+
* @summary Refresh Auto-Generated Suggestions
|
|
16002
|
+
* @param {string} xStoreID Store ID
|
|
16003
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
16004
|
+
* @param {number} [days] Number of days to analyze
|
|
16005
|
+
* @param {*} [options] Override http request option.
|
|
16006
|
+
* @throws {RequiredError}
|
|
16007
|
+
*/
|
|
16008
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsRefreshPost(xStoreID, minPopularity, days, options) {
|
|
16009
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
16010
|
+
var _a, _b, _c;
|
|
16011
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQuerySuggestionsRefreshPost(xStoreID, minPopularity, days, options);
|
|
16012
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
16013
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsStoreXStoreIDQuerySuggestionsRefreshPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
16014
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
16015
|
+
});
|
|
16016
|
+
},
|
|
16017
|
+
/**
|
|
16018
|
+
* Get statistics about query suggestions for a store
|
|
16019
|
+
* @summary Get Suggestion Statistics
|
|
16020
|
+
* @param {string} xStoreID Store ID
|
|
16021
|
+
* @param {*} [options] Override http request option.
|
|
16022
|
+
* @throws {RequiredError}
|
|
16023
|
+
*/
|
|
16024
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsStatsGet(xStoreID, options) {
|
|
16025
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
16026
|
+
var _a, _b, _c;
|
|
16027
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQuerySuggestionsStatsGet(xStoreID, options);
|
|
16028
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
16029
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsStoreXStoreIDQuerySuggestionsStatsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
16030
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
16031
|
+
});
|
|
16032
|
+
},
|
|
16033
|
+
/**
|
|
16034
|
+
* Update the status (enabled/disabled) of a query suggestion
|
|
16035
|
+
* @summary Update Suggestion Status
|
|
16036
|
+
* @param {string} xStoreID Store ID
|
|
16037
|
+
* @param {string} suggestionID Suggestion ID
|
|
16038
|
+
* @param {string} status New status (enabled, disabled)
|
|
16039
|
+
* @param {*} [options] Override http request option.
|
|
16040
|
+
* @throws {RequiredError}
|
|
16041
|
+
*/
|
|
16042
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsSuggestionIDStatusPut(xStoreID, suggestionID, status, options) {
|
|
16043
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
16044
|
+
var _a, _b, _c;
|
|
16045
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQuerySuggestionsSuggestionIDStatusPut(xStoreID, suggestionID, status, options);
|
|
16046
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
16047
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsStoreXStoreIDQuerySuggestionsSuggestionIDStatusPut']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
16048
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
16049
|
+
});
|
|
16050
|
+
},
|
|
16051
|
+
/**
|
|
16052
|
+
* Sync enabled query suggestions to Typesense collection for public API usage
|
|
16053
|
+
* @summary Sync Suggestions to Typesense
|
|
16054
|
+
* @param {string} xStoreID Store ID
|
|
16055
|
+
* @param {*} [options] Override http request option.
|
|
16056
|
+
* @throws {RequiredError}
|
|
16057
|
+
*/
|
|
16058
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsSyncPost(xStoreID, options) {
|
|
16059
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
16060
|
+
var _a, _b, _c;
|
|
16061
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQuerySuggestionsSyncPost(xStoreID, options);
|
|
16062
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
16063
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsStoreXStoreIDQuerySuggestionsSyncPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
16064
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
16065
|
+
});
|
|
16066
|
+
},
|
|
16067
|
+
/**
|
|
16068
|
+
* Retrieve query suggestions directly from Typesense collection for admin dashboard testing/viewing
|
|
16069
|
+
* @summary Get Query Suggestions from Typesense (Admin)
|
|
16070
|
+
* @param {string} xStoreID Store ID
|
|
16071
|
+
* @param {string} [query] Partial query to get suggestions for
|
|
16072
|
+
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
16073
|
+
* @param {number} [page] Page number for pagination
|
|
16074
|
+
* @param {*} [options] Override http request option.
|
|
16075
|
+
* @throws {RequiredError}
|
|
16076
|
+
*/
|
|
16077
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsTypesenseGet(xStoreID, query, hitsPerPage, page, options) {
|
|
16078
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
16079
|
+
var _a, _b, _c;
|
|
16080
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQuerySuggestionsTypesenseGet(xStoreID, query, hitsPerPage, page, options);
|
|
16081
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
16082
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsStoreXStoreIDQuerySuggestionsTypesenseGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
16083
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
16084
|
+
});
|
|
16085
|
+
},
|
|
16086
|
+
};
|
|
16087
|
+
};
|
|
16088
|
+
exports.QuerySuggestionsManagementApiFp = QuerySuggestionsManagementApiFp;
|
|
16089
|
+
/**
|
|
16090
|
+
* QuerySuggestionsManagementApi - factory interface
|
|
16091
|
+
* @export
|
|
16092
|
+
*/
|
|
16093
|
+
const QuerySuggestionsManagementApiFactory = function (configuration, basePath, axios) {
|
|
16094
|
+
const localVarFp = (0, exports.QuerySuggestionsManagementApiFp)(configuration);
|
|
16095
|
+
return {
|
|
16096
|
+
/**
|
|
16097
|
+
* Migrate existing analytics data for all stores (admin only)
|
|
16098
|
+
* @summary Migrate All Stores Data
|
|
16099
|
+
* @param {number} [daysBack] Number of days back to migrate data
|
|
16100
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
16101
|
+
* @param {*} [options] Override http request option.
|
|
16102
|
+
* @throws {RequiredError}
|
|
16103
|
+
*/
|
|
16104
|
+
adminAnalyticsQuerySuggestionsMigrateAllPost(daysBack, minPopularity, options) {
|
|
16105
|
+
return localVarFp.adminAnalyticsQuerySuggestionsMigrateAllPost(daysBack, minPopularity, options).then((request) => request(axios, basePath));
|
|
16106
|
+
},
|
|
16107
|
+
/**
|
|
16108
|
+
* Perform bulk operations on multiple suggestions (enable, disable, delete, update priority)
|
|
16109
|
+
* @summary Bulk Update Suggestions
|
|
16110
|
+
* @param {string} xStoreID Store ID
|
|
16111
|
+
* @param {AnalyticsBulkOperationRequest} body Bulk operation request
|
|
16112
|
+
* @param {*} [options] Override http request option.
|
|
16113
|
+
* @throws {RequiredError}
|
|
16114
|
+
*/
|
|
16115
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsBulkPost(xStoreID, body, options) {
|
|
16116
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQuerySuggestionsBulkPost(xStoreID, body, options).then((request) => request(axios, basePath));
|
|
16117
|
+
},
|
|
16118
|
+
/**
|
|
16119
|
+
* Retrieve auto-generated suggestions from cache for review before promoting to management table
|
|
16120
|
+
* @summary Get Cached Auto-Generated Suggestions
|
|
16121
|
+
* @param {string} xStoreID Store ID
|
|
16122
|
+
* @param {number} [page] Page number
|
|
16123
|
+
* @param {number} [pageSize] Items per page
|
|
16124
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
16125
|
+
* @param {*} [options] Override http request option.
|
|
16126
|
+
* @throws {RequiredError}
|
|
16127
|
+
*/
|
|
16128
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsCachedGet(xStoreID, page, pageSize, minPopularity, options) {
|
|
16129
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQuerySuggestionsCachedGet(xStoreID, page, pageSize, minPopularity, options).then((request) => request(axios, basePath));
|
|
16130
|
+
},
|
|
16131
|
+
/**
|
|
16132
|
+
* Retrieve query suggestions with filtering and pagination for management
|
|
16133
|
+
* @summary Get Query Suggestions
|
|
16134
|
+
* @param {string} xStoreID Store ID
|
|
16135
|
+
* @param {string} [source] Filter by source (auto_generated, manual, imported)
|
|
16136
|
+
* @param {string} [status] Filter by status (enabled, disabled)
|
|
16137
|
+
* @param {string} [query] Search within query text
|
|
16138
|
+
* @param {string} [category] Filter by category
|
|
16139
|
+
* @param {string} [tag] Filter by tag
|
|
16140
|
+
* @param {number} [page] Page number
|
|
16141
|
+
* @param {number} [pageSize] Number of items per page
|
|
16142
|
+
* @param {*} [options] Override http request option.
|
|
16143
|
+
* @throws {RequiredError}
|
|
16144
|
+
*/
|
|
16145
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsGet(xStoreID, source, status, query, category, tag, page, pageSize, options) {
|
|
16146
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQuerySuggestionsGet(xStoreID, source, status, query, category, tag, page, pageSize, options).then((request) => request(axios, basePath));
|
|
16147
|
+
},
|
|
16148
|
+
/**
|
|
16149
|
+
* Import query suggestions from JSON data
|
|
16150
|
+
* @summary Import Query Suggestions
|
|
16151
|
+
* @param {string} xStoreID Store ID
|
|
16152
|
+
* @param {AnalyticsImportQuerySuggestionsRequest} body Import suggestions request
|
|
16153
|
+
* @param {*} [options] Override http request option.
|
|
16154
|
+
* @throws {RequiredError}
|
|
16155
|
+
*/
|
|
16156
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsImportPost(xStoreID, body, options) {
|
|
16157
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQuerySuggestionsImportPost(xStoreID, body, options).then((request) => request(axios, basePath));
|
|
16158
|
+
},
|
|
16159
|
+
/**
|
|
16160
|
+
* Add a manually created query suggestion for a store
|
|
16161
|
+
* @summary Add Manual Query Suggestion
|
|
16162
|
+
* @param {string} xStoreID Store ID
|
|
16163
|
+
* @param {AnalyticsManualQuerySuggestionRequest} body Manual suggestion request
|
|
16164
|
+
* @param {*} [options] Override http request option.
|
|
16165
|
+
* @throws {RequiredError}
|
|
16166
|
+
*/
|
|
16167
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsManualPost(xStoreID, body, options) {
|
|
16168
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQuerySuggestionsManualPost(xStoreID, body, options).then((request) => request(axios, basePath));
|
|
16169
|
+
},
|
|
16170
|
+
/**
|
|
16171
|
+
* Migrate existing search analytics data to the new query suggestions management system
|
|
16172
|
+
* @summary Migrate Existing Analytics Data
|
|
16173
|
+
* @param {string} xStoreID Store ID
|
|
16174
|
+
* @param {number} [daysBack] Number of days back to migrate data
|
|
16175
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
16176
|
+
* @param {*} [options] Override http request option.
|
|
16177
|
+
* @throws {RequiredError}
|
|
16178
|
+
*/
|
|
16179
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsMigratePost(xStoreID, daysBack, minPopularity, options) {
|
|
16180
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQuerySuggestionsMigratePost(xStoreID, daysBack, minPopularity, options).then((request) => request(axios, basePath));
|
|
16181
|
+
},
|
|
16182
|
+
/**
|
|
16183
|
+
* Move ALL auto-generated suggestions from cache to the management table that meet minimum popularity criteria
|
|
16184
|
+
* @summary Promote ALL Cached Suggestions to Management Table
|
|
16185
|
+
* @param {string} xStoreID Store ID
|
|
16186
|
+
* @param {number} [minPopularity] Minimum popularity threshold (default: 5)
|
|
16187
|
+
* @param {*} [options] Override http request option.
|
|
16188
|
+
* @throws {RequiredError}
|
|
16189
|
+
*/
|
|
16190
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsPromoteAllPost(xStoreID, minPopularity, options) {
|
|
16191
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQuerySuggestionsPromoteAllPost(xStoreID, minPopularity, options).then((request) => request(axios, basePath));
|
|
16192
|
+
},
|
|
16193
|
+
/**
|
|
16194
|
+
* Move selected auto-generated suggestions from cache to the management table
|
|
16195
|
+
* @summary Promote Cached Suggestions to Management Table
|
|
16196
|
+
* @param {string} xStoreID Store ID
|
|
16197
|
+
* @param {AnalyticsPromoteSuggestionsRequest} body Promotion request
|
|
16198
|
+
* @param {*} [options] Override http request option.
|
|
16199
|
+
* @throws {RequiredError}
|
|
16200
|
+
*/
|
|
16201
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsPromotePost(xStoreID, body, options) {
|
|
16202
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQuerySuggestionsPromotePost(xStoreID, body, options).then((request) => request(axios, basePath));
|
|
16203
|
+
},
|
|
16204
|
+
/**
|
|
16205
|
+
* Refresh auto-generated suggestions from search analytics data
|
|
16206
|
+
* @summary Refresh Auto-Generated Suggestions
|
|
16207
|
+
* @param {string} xStoreID Store ID
|
|
16208
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
16209
|
+
* @param {number} [days] Number of days to analyze
|
|
16210
|
+
* @param {*} [options] Override http request option.
|
|
16211
|
+
* @throws {RequiredError}
|
|
16212
|
+
*/
|
|
16213
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsRefreshPost(xStoreID, minPopularity, days, options) {
|
|
16214
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQuerySuggestionsRefreshPost(xStoreID, minPopularity, days, options).then((request) => request(axios, basePath));
|
|
16215
|
+
},
|
|
16216
|
+
/**
|
|
16217
|
+
* Get statistics about query suggestions for a store
|
|
16218
|
+
* @summary Get Suggestion Statistics
|
|
16219
|
+
* @param {string} xStoreID Store ID
|
|
16220
|
+
* @param {*} [options] Override http request option.
|
|
16221
|
+
* @throws {RequiredError}
|
|
16222
|
+
*/
|
|
16223
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsStatsGet(xStoreID, options) {
|
|
16224
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQuerySuggestionsStatsGet(xStoreID, options).then((request) => request(axios, basePath));
|
|
16225
|
+
},
|
|
16226
|
+
/**
|
|
16227
|
+
* Update the status (enabled/disabled) of a query suggestion
|
|
16228
|
+
* @summary Update Suggestion Status
|
|
16229
|
+
* @param {string} xStoreID Store ID
|
|
16230
|
+
* @param {string} suggestionID Suggestion ID
|
|
16231
|
+
* @param {string} status New status (enabled, disabled)
|
|
16232
|
+
* @param {*} [options] Override http request option.
|
|
16233
|
+
* @throws {RequiredError}
|
|
16234
|
+
*/
|
|
16235
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsSuggestionIDStatusPut(xStoreID, suggestionID, status, options) {
|
|
16236
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQuerySuggestionsSuggestionIDStatusPut(xStoreID, suggestionID, status, options).then((request) => request(axios, basePath));
|
|
16237
|
+
},
|
|
16238
|
+
/**
|
|
16239
|
+
* Sync enabled query suggestions to Typesense collection for public API usage
|
|
16240
|
+
* @summary Sync Suggestions to Typesense
|
|
16241
|
+
* @param {string} xStoreID Store ID
|
|
16242
|
+
* @param {*} [options] Override http request option.
|
|
16243
|
+
* @throws {RequiredError}
|
|
16244
|
+
*/
|
|
16245
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsSyncPost(xStoreID, options) {
|
|
16246
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQuerySuggestionsSyncPost(xStoreID, options).then((request) => request(axios, basePath));
|
|
16247
|
+
},
|
|
16248
|
+
/**
|
|
16249
|
+
* Retrieve query suggestions directly from Typesense collection for admin dashboard testing/viewing
|
|
16250
|
+
* @summary Get Query Suggestions from Typesense (Admin)
|
|
16251
|
+
* @param {string} xStoreID Store ID
|
|
16252
|
+
* @param {string} [query] Partial query to get suggestions for
|
|
16253
|
+
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
16254
|
+
* @param {number} [page] Page number for pagination
|
|
16255
|
+
* @param {*} [options] Override http request option.
|
|
16256
|
+
* @throws {RequiredError}
|
|
16257
|
+
*/
|
|
16258
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsTypesenseGet(xStoreID, query, hitsPerPage, page, options) {
|
|
16259
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQuerySuggestionsTypesenseGet(xStoreID, query, hitsPerPage, page, options).then((request) => request(axios, basePath));
|
|
16260
|
+
},
|
|
16261
|
+
};
|
|
16262
|
+
};
|
|
16263
|
+
exports.QuerySuggestionsManagementApiFactory = QuerySuggestionsManagementApiFactory;
|
|
16264
|
+
/**
|
|
16265
|
+
* QuerySuggestionsManagementApi - object-oriented interface
|
|
16266
|
+
* @export
|
|
16267
|
+
* @class QuerySuggestionsManagementApi
|
|
16268
|
+
* @extends {BaseAPI}
|
|
16269
|
+
*/
|
|
16270
|
+
class QuerySuggestionsManagementApi extends base_1.BaseAPI {
|
|
16271
|
+
/**
|
|
16272
|
+
* Migrate existing analytics data for all stores (admin only)
|
|
16273
|
+
* @summary Migrate All Stores Data
|
|
16274
|
+
* @param {number} [daysBack] Number of days back to migrate data
|
|
16275
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
16276
|
+
* @param {*} [options] Override http request option.
|
|
16277
|
+
* @throws {RequiredError}
|
|
16278
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16279
|
+
*/
|
|
16280
|
+
adminAnalyticsQuerySuggestionsMigrateAllPost(daysBack, minPopularity, options) {
|
|
16281
|
+
return (0, exports.QuerySuggestionsManagementApiFp)(this.configuration).adminAnalyticsQuerySuggestionsMigrateAllPost(daysBack, minPopularity, options).then((request) => request(this.axios, this.basePath));
|
|
16282
|
+
}
|
|
16283
|
+
/**
|
|
16284
|
+
* Perform bulk operations on multiple suggestions (enable, disable, delete, update priority)
|
|
16285
|
+
* @summary Bulk Update Suggestions
|
|
16286
|
+
* @param {string} xStoreID Store ID
|
|
16287
|
+
* @param {AnalyticsBulkOperationRequest} body Bulk operation request
|
|
16288
|
+
* @param {*} [options] Override http request option.
|
|
16289
|
+
* @throws {RequiredError}
|
|
16290
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16291
|
+
*/
|
|
16292
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsBulkPost(xStoreID, body, options) {
|
|
16293
|
+
return (0, exports.QuerySuggestionsManagementApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQuerySuggestionsBulkPost(xStoreID, body, options).then((request) => request(this.axios, this.basePath));
|
|
16294
|
+
}
|
|
16295
|
+
/**
|
|
16296
|
+
* Retrieve auto-generated suggestions from cache for review before promoting to management table
|
|
16297
|
+
* @summary Get Cached Auto-Generated Suggestions
|
|
16298
|
+
* @param {string} xStoreID Store ID
|
|
16299
|
+
* @param {number} [page] Page number
|
|
16300
|
+
* @param {number} [pageSize] Items per page
|
|
16301
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
16302
|
+
* @param {*} [options] Override http request option.
|
|
16303
|
+
* @throws {RequiredError}
|
|
16304
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16305
|
+
*/
|
|
16306
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsCachedGet(xStoreID, page, pageSize, minPopularity, options) {
|
|
16307
|
+
return (0, exports.QuerySuggestionsManagementApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQuerySuggestionsCachedGet(xStoreID, page, pageSize, minPopularity, options).then((request) => request(this.axios, this.basePath));
|
|
16308
|
+
}
|
|
16309
|
+
/**
|
|
16310
|
+
* Retrieve query suggestions with filtering and pagination for management
|
|
16311
|
+
* @summary Get Query Suggestions
|
|
16312
|
+
* @param {string} xStoreID Store ID
|
|
16313
|
+
* @param {string} [source] Filter by source (auto_generated, manual, imported)
|
|
16314
|
+
* @param {string} [status] Filter by status (enabled, disabled)
|
|
16315
|
+
* @param {string} [query] Search within query text
|
|
16316
|
+
* @param {string} [category] Filter by category
|
|
16317
|
+
* @param {string} [tag] Filter by tag
|
|
16318
|
+
* @param {number} [page] Page number
|
|
16319
|
+
* @param {number} [pageSize] Number of items per page
|
|
16320
|
+
* @param {*} [options] Override http request option.
|
|
16321
|
+
* @throws {RequiredError}
|
|
16322
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16323
|
+
*/
|
|
16324
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsGet(xStoreID, source, status, query, category, tag, page, pageSize, options) {
|
|
16325
|
+
return (0, exports.QuerySuggestionsManagementApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQuerySuggestionsGet(xStoreID, source, status, query, category, tag, page, pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
16326
|
+
}
|
|
16327
|
+
/**
|
|
16328
|
+
* Import query suggestions from JSON data
|
|
16329
|
+
* @summary Import Query Suggestions
|
|
16330
|
+
* @param {string} xStoreID Store ID
|
|
16331
|
+
* @param {AnalyticsImportQuerySuggestionsRequest} body Import suggestions request
|
|
16332
|
+
* @param {*} [options] Override http request option.
|
|
16333
|
+
* @throws {RequiredError}
|
|
16334
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16335
|
+
*/
|
|
16336
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsImportPost(xStoreID, body, options) {
|
|
16337
|
+
return (0, exports.QuerySuggestionsManagementApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQuerySuggestionsImportPost(xStoreID, body, options).then((request) => request(this.axios, this.basePath));
|
|
16338
|
+
}
|
|
16339
|
+
/**
|
|
16340
|
+
* Add a manually created query suggestion for a store
|
|
16341
|
+
* @summary Add Manual Query Suggestion
|
|
16342
|
+
* @param {string} xStoreID Store ID
|
|
16343
|
+
* @param {AnalyticsManualQuerySuggestionRequest} body Manual suggestion request
|
|
16344
|
+
* @param {*} [options] Override http request option.
|
|
16345
|
+
* @throws {RequiredError}
|
|
16346
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16347
|
+
*/
|
|
16348
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsManualPost(xStoreID, body, options) {
|
|
16349
|
+
return (0, exports.QuerySuggestionsManagementApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQuerySuggestionsManualPost(xStoreID, body, options).then((request) => request(this.axios, this.basePath));
|
|
16350
|
+
}
|
|
16351
|
+
/**
|
|
16352
|
+
* Migrate existing search analytics data to the new query suggestions management system
|
|
16353
|
+
* @summary Migrate Existing Analytics Data
|
|
16354
|
+
* @param {string} xStoreID Store ID
|
|
16355
|
+
* @param {number} [daysBack] Number of days back to migrate data
|
|
16356
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
16357
|
+
* @param {*} [options] Override http request option.
|
|
16358
|
+
* @throws {RequiredError}
|
|
16359
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16360
|
+
*/
|
|
16361
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsMigratePost(xStoreID, daysBack, minPopularity, options) {
|
|
16362
|
+
return (0, exports.QuerySuggestionsManagementApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQuerySuggestionsMigratePost(xStoreID, daysBack, minPopularity, options).then((request) => request(this.axios, this.basePath));
|
|
16363
|
+
}
|
|
16364
|
+
/**
|
|
16365
|
+
* Move ALL auto-generated suggestions from cache to the management table that meet minimum popularity criteria
|
|
16366
|
+
* @summary Promote ALL Cached Suggestions to Management Table
|
|
16367
|
+
* @param {string} xStoreID Store ID
|
|
16368
|
+
* @param {number} [minPopularity] Minimum popularity threshold (default: 5)
|
|
16369
|
+
* @param {*} [options] Override http request option.
|
|
16370
|
+
* @throws {RequiredError}
|
|
16371
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16372
|
+
*/
|
|
16373
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsPromoteAllPost(xStoreID, minPopularity, options) {
|
|
16374
|
+
return (0, exports.QuerySuggestionsManagementApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQuerySuggestionsPromoteAllPost(xStoreID, minPopularity, options).then((request) => request(this.axios, this.basePath));
|
|
16375
|
+
}
|
|
16376
|
+
/**
|
|
16377
|
+
* Move selected auto-generated suggestions from cache to the management table
|
|
16378
|
+
* @summary Promote Cached Suggestions to Management Table
|
|
16379
|
+
* @param {string} xStoreID Store ID
|
|
16380
|
+
* @param {AnalyticsPromoteSuggestionsRequest} body Promotion request
|
|
16381
|
+
* @param {*} [options] Override http request option.
|
|
16382
|
+
* @throws {RequiredError}
|
|
16383
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16384
|
+
*/
|
|
16385
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsPromotePost(xStoreID, body, options) {
|
|
16386
|
+
return (0, exports.QuerySuggestionsManagementApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQuerySuggestionsPromotePost(xStoreID, body, options).then((request) => request(this.axios, this.basePath));
|
|
16387
|
+
}
|
|
16388
|
+
/**
|
|
16389
|
+
* Refresh auto-generated suggestions from search analytics data
|
|
16390
|
+
* @summary Refresh Auto-Generated Suggestions
|
|
16391
|
+
* @param {string} xStoreID Store ID
|
|
16392
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
16393
|
+
* @param {number} [days] Number of days to analyze
|
|
16394
|
+
* @param {*} [options] Override http request option.
|
|
16395
|
+
* @throws {RequiredError}
|
|
16396
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16397
|
+
*/
|
|
16398
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsRefreshPost(xStoreID, minPopularity, days, options) {
|
|
16399
|
+
return (0, exports.QuerySuggestionsManagementApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQuerySuggestionsRefreshPost(xStoreID, minPopularity, days, options).then((request) => request(this.axios, this.basePath));
|
|
16400
|
+
}
|
|
16401
|
+
/**
|
|
16402
|
+
* Get statistics about query suggestions for a store
|
|
16403
|
+
* @summary Get Suggestion Statistics
|
|
16404
|
+
* @param {string} xStoreID Store ID
|
|
16405
|
+
* @param {*} [options] Override http request option.
|
|
16406
|
+
* @throws {RequiredError}
|
|
16407
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16408
|
+
*/
|
|
16409
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsStatsGet(xStoreID, options) {
|
|
16410
|
+
return (0, exports.QuerySuggestionsManagementApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQuerySuggestionsStatsGet(xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
16411
|
+
}
|
|
16412
|
+
/**
|
|
16413
|
+
* Update the status (enabled/disabled) of a query suggestion
|
|
16414
|
+
* @summary Update Suggestion Status
|
|
16415
|
+
* @param {string} xStoreID Store ID
|
|
16416
|
+
* @param {string} suggestionID Suggestion ID
|
|
16417
|
+
* @param {string} status New status (enabled, disabled)
|
|
16418
|
+
* @param {*} [options] Override http request option.
|
|
16419
|
+
* @throws {RequiredError}
|
|
16420
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16421
|
+
*/
|
|
16422
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsSuggestionIDStatusPut(xStoreID, suggestionID, status, options) {
|
|
16423
|
+
return (0, exports.QuerySuggestionsManagementApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQuerySuggestionsSuggestionIDStatusPut(xStoreID, suggestionID, status, options).then((request) => request(this.axios, this.basePath));
|
|
16424
|
+
}
|
|
16425
|
+
/**
|
|
16426
|
+
* Sync enabled query suggestions to Typesense collection for public API usage
|
|
16427
|
+
* @summary Sync Suggestions to Typesense
|
|
16428
|
+
* @param {string} xStoreID Store ID
|
|
16429
|
+
* @param {*} [options] Override http request option.
|
|
16430
|
+
* @throws {RequiredError}
|
|
16431
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16432
|
+
*/
|
|
16433
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsSyncPost(xStoreID, options) {
|
|
16434
|
+
return (0, exports.QuerySuggestionsManagementApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQuerySuggestionsSyncPost(xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
16435
|
+
}
|
|
16436
|
+
/**
|
|
16437
|
+
* Retrieve query suggestions directly from Typesense collection for admin dashboard testing/viewing
|
|
16438
|
+
* @summary Get Query Suggestions from Typesense (Admin)
|
|
16439
|
+
* @param {string} xStoreID Store ID
|
|
16440
|
+
* @param {string} [query] Partial query to get suggestions for
|
|
16441
|
+
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
16442
|
+
* @param {number} [page] Page number for pagination
|
|
16443
|
+
* @param {*} [options] Override http request option.
|
|
16444
|
+
* @throws {RequiredError}
|
|
16445
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16446
|
+
*/
|
|
16447
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsTypesenseGet(xStoreID, query, hitsPerPage, page, options) {
|
|
16448
|
+
return (0, exports.QuerySuggestionsManagementApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQuerySuggestionsTypesenseGet(xStoreID, query, hitsPerPage, page, options).then((request) => request(this.axios, this.basePath));
|
|
16449
|
+
}
|
|
16450
|
+
}
|
|
16451
|
+
exports.QuerySuggestionsManagementApi = QuerySuggestionsManagementApi;
|
|
14446
16452
|
/**
|
|
14447
16453
|
* RegisterApi - axios parameter creator
|
|
14448
16454
|
* @export
|