@seekora-ai/admin-api 1.1.80 → 1.1.81
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 +4 -2
- package/api.ts +587 -23
- package/dist/api.d.ts +342 -20
- package/dist/api.js +452 -23
- package/dist/esm/api.d.ts +342 -20
- package/dist/esm/api.js +452 -23
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.1.81.tgz +0 -0
- package/seekora-ai-admin-api-1.1.80.tgz +0 -0
package/dist/esm/api.js
CHANGED
|
@@ -34869,29 +34869,38 @@ export const QuerySuggestionsApiAxiosParamCreator = function (configuration) {
|
|
|
34869
34869
|
};
|
|
34870
34870
|
}),
|
|
34871
34871
|
/**
|
|
34872
|
-
* Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering,
|
|
34872
|
+
* Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering, configurable time ranges, and dropdown recommendations with filtered tabs. Supports personalization via x-user-id, x-anon-id, x-session-id headers. Full feature parity with POST endpoint.
|
|
34873
34873
|
* @summary Get Query Suggestions
|
|
34874
34874
|
* @param {string} xStoreid Store ID
|
|
34875
34875
|
* @param {string} xStoresecret Store Secret
|
|
34876
34876
|
* @param {string} [xUserId] User ID for personalization (logged-in user)
|
|
34877
34877
|
* @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
|
|
34878
34878
|
* @param {string} [xSessionId] Session ID for personalization
|
|
34879
|
-
* @param {string} [query] Partial query to get suggestions for
|
|
34879
|
+
* @param {string} [query] Partial query to get suggestions for (supports both \'query\' and \'q\')
|
|
34880
|
+
* @param {string} [q] Alias for \'query\' parameter
|
|
34880
34881
|
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
34881
34882
|
* @param {number} [page] Page number for pagination
|
|
34882
34883
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
|
|
34883
34884
|
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
|
|
34884
34885
|
* @param {boolean} [includeCategories] Include category information in suggestions
|
|
34885
34886
|
* @param {boolean} [includeFacets] Include popular facets/filters information
|
|
34887
|
+
* @param {boolean} [includeDropdownRecommendations] Include rich dropdown recommendations (trending products, filtered tabs)
|
|
34888
|
+
* @param {boolean} [includeDropdownProductList] Include product list in dropdown recommendations
|
|
34889
|
+
* @param {boolean} [includeFilteredTabs] Include filtered tabs in dropdown recommendations
|
|
34890
|
+
* @param {boolean} [includeEmptyQueryRecommendations] Return popular suggestions when query is empty
|
|
34886
34891
|
* @param {number} [maxCategories] Maximum categories per suggestion
|
|
34887
34892
|
* @param {number} [maxFacets] Maximum facets per suggestion
|
|
34888
34893
|
* @param {number} [minPopularity] Minimum popularity threshold
|
|
34889
34894
|
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
|
|
34890
34895
|
* @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
|
|
34896
|
+
* @param {string} [filteredTabs] URL-encoded JSON array of filtered tab configurations (e.g., [{\\
|
|
34897
|
+
* @param {string} [userId] User ID for personalization (query param fallback, header takes precedence)
|
|
34898
|
+
* @param {string} [anonId] Anonymous ID for personalization (query param fallback, header takes precedence)
|
|
34899
|
+
* @param {string} [sessionId] Session ID for personalization (query param fallback, header takes precedence)
|
|
34891
34900
|
* @param {*} [options] Override http request option.
|
|
34892
34901
|
* @throws {RequiredError}
|
|
34893
34902
|
*/
|
|
34894
|
-
v1SuggestionsQueriesGet: (xStoreid_1, xStoresecret_1, xUserId_1, xAnonId_1, xSessionId_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, xUserId_1, xAnonId_1, xSessionId_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, xUserId, xAnonId, xSessionId, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options = {}) {
|
|
34903
|
+
v1SuggestionsQueriesGet: (xStoreid_1, xStoresecret_1, xUserId_1, xAnonId_1, xSessionId_1, query_1, q_1, hitsPerPage_1, page_1, analyticsTags_1, tagsMatchMode_1, includeCategories_1, includeFacets_1, includeDropdownRecommendations_1, includeDropdownProductList_1, includeFilteredTabs_1, includeEmptyQueryRecommendations_1, maxCategories_1, maxFacets_1, minPopularity_1, timeRange_1, disableTypoTolerance_1, filteredTabs_1, userId_1, anonId_1, sessionId_1, ...args_1) => __awaiter(this, [xStoreid_1, xStoresecret_1, xUserId_1, xAnonId_1, xSessionId_1, query_1, q_1, hitsPerPage_1, page_1, analyticsTags_1, tagsMatchMode_1, includeCategories_1, includeFacets_1, includeDropdownRecommendations_1, includeDropdownProductList_1, includeFilteredTabs_1, includeEmptyQueryRecommendations_1, maxCategories_1, maxFacets_1, minPopularity_1, timeRange_1, disableTypoTolerance_1, filteredTabs_1, userId_1, anonId_1, sessionId_1, ...args_1], void 0, function* (xStoreid, xStoresecret, xUserId, xAnonId, xSessionId, query, q, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, includeDropdownRecommendations, includeDropdownProductList, includeFilteredTabs, includeEmptyQueryRecommendations, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, filteredTabs, userId, anonId, sessionId, options = {}) {
|
|
34895
34904
|
// verify required parameter 'xStoreid' is not null or undefined
|
|
34896
34905
|
assertParamExists('v1SuggestionsQueriesGet', 'xStoreid', xStoreid);
|
|
34897
34906
|
// verify required parameter 'xStoresecret' is not null or undefined
|
|
@@ -34909,6 +34918,9 @@ export const QuerySuggestionsApiAxiosParamCreator = function (configuration) {
|
|
|
34909
34918
|
if (query !== undefined) {
|
|
34910
34919
|
localVarQueryParameter['query'] = query;
|
|
34911
34920
|
}
|
|
34921
|
+
if (q !== undefined) {
|
|
34922
|
+
localVarQueryParameter['q'] = q;
|
|
34923
|
+
}
|
|
34912
34924
|
if (hitsPerPage !== undefined) {
|
|
34913
34925
|
localVarQueryParameter['hitsPerPage'] = hitsPerPage;
|
|
34914
34926
|
}
|
|
@@ -34927,6 +34939,18 @@ export const QuerySuggestionsApiAxiosParamCreator = function (configuration) {
|
|
|
34927
34939
|
if (includeFacets !== undefined) {
|
|
34928
34940
|
localVarQueryParameter['include_facets'] = includeFacets;
|
|
34929
34941
|
}
|
|
34942
|
+
if (includeDropdownRecommendations !== undefined) {
|
|
34943
|
+
localVarQueryParameter['include_dropdown_recommendations'] = includeDropdownRecommendations;
|
|
34944
|
+
}
|
|
34945
|
+
if (includeDropdownProductList !== undefined) {
|
|
34946
|
+
localVarQueryParameter['include_dropdown_product_list'] = includeDropdownProductList;
|
|
34947
|
+
}
|
|
34948
|
+
if (includeFilteredTabs !== undefined) {
|
|
34949
|
+
localVarQueryParameter['include_filtered_tabs'] = includeFilteredTabs;
|
|
34950
|
+
}
|
|
34951
|
+
if (includeEmptyQueryRecommendations !== undefined) {
|
|
34952
|
+
localVarQueryParameter['include_empty_query_recommendations'] = includeEmptyQueryRecommendations;
|
|
34953
|
+
}
|
|
34930
34954
|
if (maxCategories !== undefined) {
|
|
34931
34955
|
localVarQueryParameter['max_categories'] = maxCategories;
|
|
34932
34956
|
}
|
|
@@ -34942,6 +34966,18 @@ export const QuerySuggestionsApiAxiosParamCreator = function (configuration) {
|
|
|
34942
34966
|
if (disableTypoTolerance !== undefined) {
|
|
34943
34967
|
localVarQueryParameter['disable_typo_tolerance'] = disableTypoTolerance;
|
|
34944
34968
|
}
|
|
34969
|
+
if (filteredTabs !== undefined) {
|
|
34970
|
+
localVarQueryParameter['filtered_tabs'] = filteredTabs;
|
|
34971
|
+
}
|
|
34972
|
+
if (userId !== undefined) {
|
|
34973
|
+
localVarQueryParameter['user_id'] = userId;
|
|
34974
|
+
}
|
|
34975
|
+
if (anonId !== undefined) {
|
|
34976
|
+
localVarQueryParameter['anon_id'] = anonId;
|
|
34977
|
+
}
|
|
34978
|
+
if (sessionId !== undefined) {
|
|
34979
|
+
localVarQueryParameter['session_id'] = sessionId;
|
|
34980
|
+
}
|
|
34945
34981
|
if (xStoreid != null) {
|
|
34946
34982
|
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
34947
34983
|
}
|
|
@@ -34966,14 +35002,14 @@ export const QuerySuggestionsApiAxiosParamCreator = function (configuration) {
|
|
|
34966
35002
|
};
|
|
34967
35003
|
}),
|
|
34968
35004
|
/**
|
|
34969
|
-
* Same as GET
|
|
35005
|
+
* Same as GET endpoint with full feature parity. Retrieve query suggestions with optional JSON body (query, hitsPerPage, analytics_tags, filtered_tabs, dropdown recommendations, etc.). Use POST when sending complex filtered_tabs as JSON is more convenient than URL-encoded query params. Supports personalization via x-user-id, x-anon-id, x-session-id headers. Both GET and POST return identical responses.
|
|
34970
35006
|
* @summary Post Query Suggestions
|
|
34971
35007
|
* @param {string} xStoreid Store ID
|
|
34972
35008
|
* @param {string} xStoresecret Store Secret
|
|
34973
35009
|
* @param {string} [xUserId] User ID for personalization (logged-in user)
|
|
34974
35010
|
* @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
|
|
34975
35011
|
* @param {string} [xSessionId] Session ID for personalization
|
|
34976
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, filtered_tabs, etc.)
|
|
35012
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, include_dropdown_recommendations, filtered_tabs, etc.)
|
|
34977
35013
|
* @param {*} [options] Override http request option.
|
|
34978
35014
|
* @throws {RequiredError}
|
|
34979
35015
|
*/
|
|
@@ -35044,46 +35080,55 @@ export const QuerySuggestionsApiFp = function (configuration) {
|
|
|
35044
35080
|
});
|
|
35045
35081
|
},
|
|
35046
35082
|
/**
|
|
35047
|
-
* Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering,
|
|
35083
|
+
* Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering, configurable time ranges, and dropdown recommendations with filtered tabs. Supports personalization via x-user-id, x-anon-id, x-session-id headers. Full feature parity with POST endpoint.
|
|
35048
35084
|
* @summary Get Query Suggestions
|
|
35049
35085
|
* @param {string} xStoreid Store ID
|
|
35050
35086
|
* @param {string} xStoresecret Store Secret
|
|
35051
35087
|
* @param {string} [xUserId] User ID for personalization (logged-in user)
|
|
35052
35088
|
* @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
|
|
35053
35089
|
* @param {string} [xSessionId] Session ID for personalization
|
|
35054
|
-
* @param {string} [query] Partial query to get suggestions for
|
|
35090
|
+
* @param {string} [query] Partial query to get suggestions for (supports both \'query\' and \'q\')
|
|
35091
|
+
* @param {string} [q] Alias for \'query\' parameter
|
|
35055
35092
|
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
35056
35093
|
* @param {number} [page] Page number for pagination
|
|
35057
35094
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
|
|
35058
35095
|
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
|
|
35059
35096
|
* @param {boolean} [includeCategories] Include category information in suggestions
|
|
35060
35097
|
* @param {boolean} [includeFacets] Include popular facets/filters information
|
|
35098
|
+
* @param {boolean} [includeDropdownRecommendations] Include rich dropdown recommendations (trending products, filtered tabs)
|
|
35099
|
+
* @param {boolean} [includeDropdownProductList] Include product list in dropdown recommendations
|
|
35100
|
+
* @param {boolean} [includeFilteredTabs] Include filtered tabs in dropdown recommendations
|
|
35101
|
+
* @param {boolean} [includeEmptyQueryRecommendations] Return popular suggestions when query is empty
|
|
35061
35102
|
* @param {number} [maxCategories] Maximum categories per suggestion
|
|
35062
35103
|
* @param {number} [maxFacets] Maximum facets per suggestion
|
|
35063
35104
|
* @param {number} [minPopularity] Minimum popularity threshold
|
|
35064
35105
|
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
|
|
35065
35106
|
* @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
|
|
35107
|
+
* @param {string} [filteredTabs] URL-encoded JSON array of filtered tab configurations (e.g., [{\\
|
|
35108
|
+
* @param {string} [userId] User ID for personalization (query param fallback, header takes precedence)
|
|
35109
|
+
* @param {string} [anonId] Anonymous ID for personalization (query param fallback, header takes precedence)
|
|
35110
|
+
* @param {string} [sessionId] Session ID for personalization (query param fallback, header takes precedence)
|
|
35066
35111
|
* @param {*} [options] Override http request option.
|
|
35067
35112
|
* @throws {RequiredError}
|
|
35068
35113
|
*/
|
|
35069
|
-
v1SuggestionsQueriesGet(xStoreid, xStoresecret, xUserId, xAnonId, xSessionId, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options) {
|
|
35114
|
+
v1SuggestionsQueriesGet(xStoreid, xStoresecret, xUserId, xAnonId, xSessionId, query, q, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, includeDropdownRecommendations, includeDropdownProductList, includeFilteredTabs, includeEmptyQueryRecommendations, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, filteredTabs, userId, anonId, sessionId, options) {
|
|
35070
35115
|
return __awaiter(this, void 0, void 0, function* () {
|
|
35071
35116
|
var _a, _b, _c;
|
|
35072
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1SuggestionsQueriesGet(xStoreid, xStoresecret, xUserId, xAnonId, xSessionId, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options);
|
|
35117
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1SuggestionsQueriesGet(xStoreid, xStoresecret, xUserId, xAnonId, xSessionId, query, q, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, includeDropdownRecommendations, includeDropdownProductList, includeFilteredTabs, includeEmptyQueryRecommendations, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, filteredTabs, userId, anonId, sessionId, options);
|
|
35073
35118
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
35074
35119
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['QuerySuggestionsApi.v1SuggestionsQueriesGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
35075
35120
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
35076
35121
|
});
|
|
35077
35122
|
},
|
|
35078
35123
|
/**
|
|
35079
|
-
* Same as GET
|
|
35124
|
+
* Same as GET endpoint with full feature parity. Retrieve query suggestions with optional JSON body (query, hitsPerPage, analytics_tags, filtered_tabs, dropdown recommendations, etc.). Use POST when sending complex filtered_tabs as JSON is more convenient than URL-encoded query params. Supports personalization via x-user-id, x-anon-id, x-session-id headers. Both GET and POST return identical responses.
|
|
35080
35125
|
* @summary Post Query Suggestions
|
|
35081
35126
|
* @param {string} xStoreid Store ID
|
|
35082
35127
|
* @param {string} xStoresecret Store Secret
|
|
35083
35128
|
* @param {string} [xUserId] User ID for personalization (logged-in user)
|
|
35084
35129
|
* @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
|
|
35085
35130
|
* @param {string} [xSessionId] Session ID for personalization
|
|
35086
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, filtered_tabs, etc.)
|
|
35131
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, include_dropdown_recommendations, filtered_tabs, etc.)
|
|
35087
35132
|
* @param {*} [options] Override http request option.
|
|
35088
35133
|
* @throws {RequiredError}
|
|
35089
35134
|
*/
|
|
@@ -35117,40 +35162,49 @@ export const QuerySuggestionsApiFactory = function (configuration, basePath, axi
|
|
|
35117
35162
|
return localVarFp.v1SuggestionsConfigGet(xStoreid, xStoresecret, options).then((request) => request(axios, basePath));
|
|
35118
35163
|
},
|
|
35119
35164
|
/**
|
|
35120
|
-
* Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering,
|
|
35165
|
+
* Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering, configurable time ranges, and dropdown recommendations with filtered tabs. Supports personalization via x-user-id, x-anon-id, x-session-id headers. Full feature parity with POST endpoint.
|
|
35121
35166
|
* @summary Get Query Suggestions
|
|
35122
35167
|
* @param {string} xStoreid Store ID
|
|
35123
35168
|
* @param {string} xStoresecret Store Secret
|
|
35124
35169
|
* @param {string} [xUserId] User ID for personalization (logged-in user)
|
|
35125
35170
|
* @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
|
|
35126
35171
|
* @param {string} [xSessionId] Session ID for personalization
|
|
35127
|
-
* @param {string} [query] Partial query to get suggestions for
|
|
35172
|
+
* @param {string} [query] Partial query to get suggestions for (supports both \'query\' and \'q\')
|
|
35173
|
+
* @param {string} [q] Alias for \'query\' parameter
|
|
35128
35174
|
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
35129
35175
|
* @param {number} [page] Page number for pagination
|
|
35130
35176
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
|
|
35131
35177
|
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
|
|
35132
35178
|
* @param {boolean} [includeCategories] Include category information in suggestions
|
|
35133
35179
|
* @param {boolean} [includeFacets] Include popular facets/filters information
|
|
35180
|
+
* @param {boolean} [includeDropdownRecommendations] Include rich dropdown recommendations (trending products, filtered tabs)
|
|
35181
|
+
* @param {boolean} [includeDropdownProductList] Include product list in dropdown recommendations
|
|
35182
|
+
* @param {boolean} [includeFilteredTabs] Include filtered tabs in dropdown recommendations
|
|
35183
|
+
* @param {boolean} [includeEmptyQueryRecommendations] Return popular suggestions when query is empty
|
|
35134
35184
|
* @param {number} [maxCategories] Maximum categories per suggestion
|
|
35135
35185
|
* @param {number} [maxFacets] Maximum facets per suggestion
|
|
35136
35186
|
* @param {number} [minPopularity] Minimum popularity threshold
|
|
35137
35187
|
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
|
|
35138
35188
|
* @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
|
|
35189
|
+
* @param {string} [filteredTabs] URL-encoded JSON array of filtered tab configurations (e.g., [{\\
|
|
35190
|
+
* @param {string} [userId] User ID for personalization (query param fallback, header takes precedence)
|
|
35191
|
+
* @param {string} [anonId] Anonymous ID for personalization (query param fallback, header takes precedence)
|
|
35192
|
+
* @param {string} [sessionId] Session ID for personalization (query param fallback, header takes precedence)
|
|
35139
35193
|
* @param {*} [options] Override http request option.
|
|
35140
35194
|
* @throws {RequiredError}
|
|
35141
35195
|
*/
|
|
35142
|
-
v1SuggestionsQueriesGet(xStoreid, xStoresecret, xUserId, xAnonId, xSessionId, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options) {
|
|
35143
|
-
return localVarFp.v1SuggestionsQueriesGet(xStoreid, xStoresecret, xUserId, xAnonId, xSessionId, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options).then((request) => request(axios, basePath));
|
|
35196
|
+
v1SuggestionsQueriesGet(xStoreid, xStoresecret, xUserId, xAnonId, xSessionId, query, q, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, includeDropdownRecommendations, includeDropdownProductList, includeFilteredTabs, includeEmptyQueryRecommendations, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, filteredTabs, userId, anonId, sessionId, options) {
|
|
35197
|
+
return localVarFp.v1SuggestionsQueriesGet(xStoreid, xStoresecret, xUserId, xAnonId, xSessionId, query, q, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, includeDropdownRecommendations, includeDropdownProductList, includeFilteredTabs, includeEmptyQueryRecommendations, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, filteredTabs, userId, anonId, sessionId, options).then((request) => request(axios, basePath));
|
|
35144
35198
|
},
|
|
35145
35199
|
/**
|
|
35146
|
-
* Same as GET
|
|
35200
|
+
* Same as GET endpoint with full feature parity. Retrieve query suggestions with optional JSON body (query, hitsPerPage, analytics_tags, filtered_tabs, dropdown recommendations, etc.). Use POST when sending complex filtered_tabs as JSON is more convenient than URL-encoded query params. Supports personalization via x-user-id, x-anon-id, x-session-id headers. Both GET and POST return identical responses.
|
|
35147
35201
|
* @summary Post Query Suggestions
|
|
35148
35202
|
* @param {string} xStoreid Store ID
|
|
35149
35203
|
* @param {string} xStoresecret Store Secret
|
|
35150
35204
|
* @param {string} [xUserId] User ID for personalization (logged-in user)
|
|
35151
35205
|
* @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
|
|
35152
35206
|
* @param {string} [xSessionId] Session ID for personalization
|
|
35153
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, filtered_tabs, etc.)
|
|
35207
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, include_dropdown_recommendations, filtered_tabs, etc.)
|
|
35154
35208
|
* @param {*} [options] Override http request option.
|
|
35155
35209
|
* @throws {RequiredError}
|
|
35156
35210
|
*/
|
|
@@ -35179,41 +35233,50 @@ export class QuerySuggestionsApi extends BaseAPI {
|
|
|
35179
35233
|
return QuerySuggestionsApiFp(this.configuration).v1SuggestionsConfigGet(xStoreid, xStoresecret, options).then((request) => request(this.axios, this.basePath));
|
|
35180
35234
|
}
|
|
35181
35235
|
/**
|
|
35182
|
-
* Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering,
|
|
35236
|
+
* Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering, configurable time ranges, and dropdown recommendations with filtered tabs. Supports personalization via x-user-id, x-anon-id, x-session-id headers. Full feature parity with POST endpoint.
|
|
35183
35237
|
* @summary Get Query Suggestions
|
|
35184
35238
|
* @param {string} xStoreid Store ID
|
|
35185
35239
|
* @param {string} xStoresecret Store Secret
|
|
35186
35240
|
* @param {string} [xUserId] User ID for personalization (logged-in user)
|
|
35187
35241
|
* @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
|
|
35188
35242
|
* @param {string} [xSessionId] Session ID for personalization
|
|
35189
|
-
* @param {string} [query] Partial query to get suggestions for
|
|
35243
|
+
* @param {string} [query] Partial query to get suggestions for (supports both \'query\' and \'q\')
|
|
35244
|
+
* @param {string} [q] Alias for \'query\' parameter
|
|
35190
35245
|
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
35191
35246
|
* @param {number} [page] Page number for pagination
|
|
35192
35247
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
|
|
35193
35248
|
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
|
|
35194
35249
|
* @param {boolean} [includeCategories] Include category information in suggestions
|
|
35195
35250
|
* @param {boolean} [includeFacets] Include popular facets/filters information
|
|
35251
|
+
* @param {boolean} [includeDropdownRecommendations] Include rich dropdown recommendations (trending products, filtered tabs)
|
|
35252
|
+
* @param {boolean} [includeDropdownProductList] Include product list in dropdown recommendations
|
|
35253
|
+
* @param {boolean} [includeFilteredTabs] Include filtered tabs in dropdown recommendations
|
|
35254
|
+
* @param {boolean} [includeEmptyQueryRecommendations] Return popular suggestions when query is empty
|
|
35196
35255
|
* @param {number} [maxCategories] Maximum categories per suggestion
|
|
35197
35256
|
* @param {number} [maxFacets] Maximum facets per suggestion
|
|
35198
35257
|
* @param {number} [minPopularity] Minimum popularity threshold
|
|
35199
35258
|
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
|
|
35200
35259
|
* @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
|
|
35260
|
+
* @param {string} [filteredTabs] URL-encoded JSON array of filtered tab configurations (e.g., [{\\
|
|
35261
|
+
* @param {string} [userId] User ID for personalization (query param fallback, header takes precedence)
|
|
35262
|
+
* @param {string} [anonId] Anonymous ID for personalization (query param fallback, header takes precedence)
|
|
35263
|
+
* @param {string} [sessionId] Session ID for personalization (query param fallback, header takes precedence)
|
|
35201
35264
|
* @param {*} [options] Override http request option.
|
|
35202
35265
|
* @throws {RequiredError}
|
|
35203
35266
|
* @memberof QuerySuggestionsApi
|
|
35204
35267
|
*/
|
|
35205
|
-
v1SuggestionsQueriesGet(xStoreid, xStoresecret, xUserId, xAnonId, xSessionId, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options) {
|
|
35206
|
-
return QuerySuggestionsApiFp(this.configuration).v1SuggestionsQueriesGet(xStoreid, xStoresecret, xUserId, xAnonId, xSessionId, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options).then((request) => request(this.axios, this.basePath));
|
|
35268
|
+
v1SuggestionsQueriesGet(xStoreid, xStoresecret, xUserId, xAnonId, xSessionId, query, q, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, includeDropdownRecommendations, includeDropdownProductList, includeFilteredTabs, includeEmptyQueryRecommendations, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, filteredTabs, userId, anonId, sessionId, options) {
|
|
35269
|
+
return QuerySuggestionsApiFp(this.configuration).v1SuggestionsQueriesGet(xStoreid, xStoresecret, xUserId, xAnonId, xSessionId, query, q, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, includeDropdownRecommendations, includeDropdownProductList, includeFilteredTabs, includeEmptyQueryRecommendations, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, filteredTabs, userId, anonId, sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
35207
35270
|
}
|
|
35208
35271
|
/**
|
|
35209
|
-
* Same as GET
|
|
35272
|
+
* Same as GET endpoint with full feature parity. Retrieve query suggestions with optional JSON body (query, hitsPerPage, analytics_tags, filtered_tabs, dropdown recommendations, etc.). Use POST when sending complex filtered_tabs as JSON is more convenient than URL-encoded query params. Supports personalization via x-user-id, x-anon-id, x-session-id headers. Both GET and POST return identical responses.
|
|
35210
35273
|
* @summary Post Query Suggestions
|
|
35211
35274
|
* @param {string} xStoreid Store ID
|
|
35212
35275
|
* @param {string} xStoresecret Store Secret
|
|
35213
35276
|
* @param {string} [xUserId] User ID for personalization (logged-in user)
|
|
35214
35277
|
* @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
|
|
35215
35278
|
* @param {string} [xSessionId] Session ID for personalization
|
|
35216
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, filtered_tabs, etc.)
|
|
35279
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, include_dropdown_recommendations, filtered_tabs, etc.)
|
|
35217
35280
|
* @param {*} [options] Override http request option.
|
|
35218
35281
|
* @throws {RequiredError}
|
|
35219
35282
|
* @memberof QuerySuggestionsApi
|
|
@@ -41788,6 +41851,209 @@ export const SearchApiAxiosParamCreator = function (configuration) {
|
|
|
41788
41851
|
options: localVarRequestOptions,
|
|
41789
41852
|
};
|
|
41790
41853
|
}),
|
|
41854
|
+
/**
|
|
41855
|
+
* Search documents using query parameters. Supports all features of POST endpoint.
|
|
41856
|
+
* @summary Public Search API (GET)
|
|
41857
|
+
* @param {string} xStoreid Store ID
|
|
41858
|
+
* @param {string} xStoresecret Store Secret
|
|
41859
|
+
* @param {string} q Search query
|
|
41860
|
+
* @param {string} [xUserId] User ID for personalization
|
|
41861
|
+
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
41862
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
41863
|
+
* @param {number} [page] Page number (default: 1)
|
|
41864
|
+
* @param {number} [perPage] Items per page (default: 10)
|
|
41865
|
+
* @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
|
|
41866
|
+
* @param {string} [filterBy] Filter string (e.g., category:shirts)
|
|
41867
|
+
* @param {string} [facetBy] Facet fields (comma-separated)
|
|
41868
|
+
* @param {number} [maxFacetValues] Maximum facet values to return
|
|
41869
|
+
* @param {boolean} [widgetMode] Return widget-formatted results
|
|
41870
|
+
* @param {boolean} [includeSuggestions] Include autocomplete suggestions
|
|
41871
|
+
* @param {number} [suggestionsLimit] Number of suggestions to return
|
|
41872
|
+
* @param {string} [analyticsTags] Analytics tags (comma-separated)
|
|
41873
|
+
* @param {string} [stopwordSets] Stopword set IDs (comma-separated)
|
|
41874
|
+
* @param {string} [synonymSets] Synonym set IDs (comma-separated)
|
|
41875
|
+
* @param {string} [searchFields] Fields to search in (comma-separated)
|
|
41876
|
+
* @param {string} [returnFields] Fields to return (comma-separated)
|
|
41877
|
+
* @param {string} [omitFields] Fields to omit (comma-separated)
|
|
41878
|
+
* @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
|
|
41879
|
+
* @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
|
|
41880
|
+
* @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
|
|
41881
|
+
* @param {string} [groupField] Field to group results by
|
|
41882
|
+
* @param {number} [groupSize] Number of results per group
|
|
41883
|
+
* @param {string} [snippetPrefix] Prefix for highlighted snippets
|
|
41884
|
+
* @param {string} [snippetSuffix] Suffix for highlighted snippets
|
|
41885
|
+
* @param {number} [snippetTokenLimit] Maximum tokens in snippet
|
|
41886
|
+
* @param {number} [snippetMinLen] Minimum snippet length
|
|
41887
|
+
* @param {boolean} [includeSnippets] Include snippets in results
|
|
41888
|
+
* @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
|
|
41889
|
+
* @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
|
|
41890
|
+
* @param {number} [typoMax] Maximum typo tolerance
|
|
41891
|
+
* @param {number} [typoMinLen1] Min word length for 1 typo
|
|
41892
|
+
* @param {number} [typoMinLen2] Min word length for 2 typos
|
|
41893
|
+
* @param {number} [searchTimeoutMs] Search timeout in milliseconds
|
|
41894
|
+
* @param {boolean} [requireAllTerms] Require all search terms to match
|
|
41895
|
+
* @param {boolean} [exactMatchBoost] Boost exact matches
|
|
41896
|
+
* @param {boolean} [cacheResults] Cache search results
|
|
41897
|
+
* @param {boolean} [applyRules] Apply search rules
|
|
41898
|
+
* @param {string} [presetName] Search preset name to use
|
|
41899
|
+
* @param {string} [facetSearchText] Text to filter facet values
|
|
41900
|
+
* @param {*} [options] Override http request option.
|
|
41901
|
+
* @throws {RequiredError}
|
|
41902
|
+
*/
|
|
41903
|
+
v1SearchGet: (xStoreid_1, xStoresecret_1, q_1, xUserId_1, xAnonId_1, xSessionId_1, page_1, perPage_1, sortBy_1, filterBy_1, facetBy_1, maxFacetValues_1, widgetMode_1, includeSuggestions_1, suggestionsLimit_1, analyticsTags_1, stopwordSets_1, synonymSets_1, searchFields_1, returnFields_1, omitFields_1, snippetFields_1, fullSnippetFields_1, fieldWeights_1, groupField_1, groupSize_1, snippetPrefix_1, snippetSuffix_1, snippetTokenLimit_1, snippetMinLen_1, includeSnippets_1, prefixMode_1, infixMode_1, typoMax_1, typoMinLen1_1, typoMinLen2_1, searchTimeoutMs_1, requireAllTerms_1, exactMatchBoost_1, cacheResults_1, applyRules_1, presetName_1, facetSearchText_1, ...args_1) => __awaiter(this, [xStoreid_1, xStoresecret_1, q_1, xUserId_1, xAnonId_1, xSessionId_1, page_1, perPage_1, sortBy_1, filterBy_1, facetBy_1, maxFacetValues_1, widgetMode_1, includeSuggestions_1, suggestionsLimit_1, analyticsTags_1, stopwordSets_1, synonymSets_1, searchFields_1, returnFields_1, omitFields_1, snippetFields_1, fullSnippetFields_1, fieldWeights_1, groupField_1, groupSize_1, snippetPrefix_1, snippetSuffix_1, snippetTokenLimit_1, snippetMinLen_1, includeSnippets_1, prefixMode_1, infixMode_1, typoMax_1, typoMinLen1_1, typoMinLen2_1, searchTimeoutMs_1, requireAllTerms_1, exactMatchBoost_1, cacheResults_1, applyRules_1, presetName_1, facetSearchText_1, ...args_1], void 0, function* (xStoreid, xStoresecret, q, xUserId, xAnonId, xSessionId, page, perPage, sortBy, filterBy, facetBy, maxFacetValues, widgetMode, includeSuggestions, suggestionsLimit, analyticsTags, stopwordSets, synonymSets, searchFields, returnFields, omitFields, snippetFields, fullSnippetFields, fieldWeights, groupField, groupSize, snippetPrefix, snippetSuffix, snippetTokenLimit, snippetMinLen, includeSnippets, prefixMode, infixMode, typoMax, typoMinLen1, typoMinLen2, searchTimeoutMs, requireAllTerms, exactMatchBoost, cacheResults, applyRules, presetName, facetSearchText, options = {}) {
|
|
41904
|
+
// verify required parameter 'xStoreid' is not null or undefined
|
|
41905
|
+
assertParamExists('v1SearchGet', 'xStoreid', xStoreid);
|
|
41906
|
+
// verify required parameter 'xStoresecret' is not null or undefined
|
|
41907
|
+
assertParamExists('v1SearchGet', 'xStoresecret', xStoresecret);
|
|
41908
|
+
// verify required parameter 'q' is not null or undefined
|
|
41909
|
+
assertParamExists('v1SearchGet', 'q', q);
|
|
41910
|
+
const localVarPath = `/v1/search`;
|
|
41911
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
41912
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
41913
|
+
let baseOptions;
|
|
41914
|
+
if (configuration) {
|
|
41915
|
+
baseOptions = configuration.baseOptions;
|
|
41916
|
+
}
|
|
41917
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
41918
|
+
const localVarHeaderParameter = {};
|
|
41919
|
+
const localVarQueryParameter = {};
|
|
41920
|
+
if (q !== undefined) {
|
|
41921
|
+
localVarQueryParameter['q'] = q;
|
|
41922
|
+
}
|
|
41923
|
+
if (page !== undefined) {
|
|
41924
|
+
localVarQueryParameter['page'] = page;
|
|
41925
|
+
}
|
|
41926
|
+
if (perPage !== undefined) {
|
|
41927
|
+
localVarQueryParameter['per_page'] = perPage;
|
|
41928
|
+
}
|
|
41929
|
+
if (sortBy !== undefined) {
|
|
41930
|
+
localVarQueryParameter['sort_by'] = sortBy;
|
|
41931
|
+
}
|
|
41932
|
+
if (filterBy !== undefined) {
|
|
41933
|
+
localVarQueryParameter['filter_by'] = filterBy;
|
|
41934
|
+
}
|
|
41935
|
+
if (facetBy !== undefined) {
|
|
41936
|
+
localVarQueryParameter['facet_by'] = facetBy;
|
|
41937
|
+
}
|
|
41938
|
+
if (maxFacetValues !== undefined) {
|
|
41939
|
+
localVarQueryParameter['max_facet_values'] = maxFacetValues;
|
|
41940
|
+
}
|
|
41941
|
+
if (widgetMode !== undefined) {
|
|
41942
|
+
localVarQueryParameter['widget_mode'] = widgetMode;
|
|
41943
|
+
}
|
|
41944
|
+
if (includeSuggestions !== undefined) {
|
|
41945
|
+
localVarQueryParameter['include_suggestions'] = includeSuggestions;
|
|
41946
|
+
}
|
|
41947
|
+
if (suggestionsLimit !== undefined) {
|
|
41948
|
+
localVarQueryParameter['suggestions_limit'] = suggestionsLimit;
|
|
41949
|
+
}
|
|
41950
|
+
if (analyticsTags !== undefined) {
|
|
41951
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
41952
|
+
}
|
|
41953
|
+
if (stopwordSets !== undefined) {
|
|
41954
|
+
localVarQueryParameter['stopword_sets'] = stopwordSets;
|
|
41955
|
+
}
|
|
41956
|
+
if (synonymSets !== undefined) {
|
|
41957
|
+
localVarQueryParameter['synonym_sets'] = synonymSets;
|
|
41958
|
+
}
|
|
41959
|
+
if (searchFields !== undefined) {
|
|
41960
|
+
localVarQueryParameter['search_fields'] = searchFields;
|
|
41961
|
+
}
|
|
41962
|
+
if (returnFields !== undefined) {
|
|
41963
|
+
localVarQueryParameter['return_fields'] = returnFields;
|
|
41964
|
+
}
|
|
41965
|
+
if (omitFields !== undefined) {
|
|
41966
|
+
localVarQueryParameter['omit_fields'] = omitFields;
|
|
41967
|
+
}
|
|
41968
|
+
if (snippetFields !== undefined) {
|
|
41969
|
+
localVarQueryParameter['snippet_fields'] = snippetFields;
|
|
41970
|
+
}
|
|
41971
|
+
if (fullSnippetFields !== undefined) {
|
|
41972
|
+
localVarQueryParameter['full_snippet_fields'] = fullSnippetFields;
|
|
41973
|
+
}
|
|
41974
|
+
if (fieldWeights !== undefined) {
|
|
41975
|
+
localVarQueryParameter['field_weights'] = fieldWeights;
|
|
41976
|
+
}
|
|
41977
|
+
if (groupField !== undefined) {
|
|
41978
|
+
localVarQueryParameter['group_field'] = groupField;
|
|
41979
|
+
}
|
|
41980
|
+
if (groupSize !== undefined) {
|
|
41981
|
+
localVarQueryParameter['group_size'] = groupSize;
|
|
41982
|
+
}
|
|
41983
|
+
if (snippetPrefix !== undefined) {
|
|
41984
|
+
localVarQueryParameter['snippet_prefix'] = snippetPrefix;
|
|
41985
|
+
}
|
|
41986
|
+
if (snippetSuffix !== undefined) {
|
|
41987
|
+
localVarQueryParameter['snippet_suffix'] = snippetSuffix;
|
|
41988
|
+
}
|
|
41989
|
+
if (snippetTokenLimit !== undefined) {
|
|
41990
|
+
localVarQueryParameter['snippet_token_limit'] = snippetTokenLimit;
|
|
41991
|
+
}
|
|
41992
|
+
if (snippetMinLen !== undefined) {
|
|
41993
|
+
localVarQueryParameter['snippet_min_len'] = snippetMinLen;
|
|
41994
|
+
}
|
|
41995
|
+
if (includeSnippets !== undefined) {
|
|
41996
|
+
localVarQueryParameter['include_snippets'] = includeSnippets;
|
|
41997
|
+
}
|
|
41998
|
+
if (prefixMode !== undefined) {
|
|
41999
|
+
localVarQueryParameter['prefix_mode'] = prefixMode;
|
|
42000
|
+
}
|
|
42001
|
+
if (infixMode !== undefined) {
|
|
42002
|
+
localVarQueryParameter['infix_mode'] = infixMode;
|
|
42003
|
+
}
|
|
42004
|
+
if (typoMax !== undefined) {
|
|
42005
|
+
localVarQueryParameter['typo_max'] = typoMax;
|
|
42006
|
+
}
|
|
42007
|
+
if (typoMinLen1 !== undefined) {
|
|
42008
|
+
localVarQueryParameter['typo_min_len_1'] = typoMinLen1;
|
|
42009
|
+
}
|
|
42010
|
+
if (typoMinLen2 !== undefined) {
|
|
42011
|
+
localVarQueryParameter['typo_min_len_2'] = typoMinLen2;
|
|
42012
|
+
}
|
|
42013
|
+
if (searchTimeoutMs !== undefined) {
|
|
42014
|
+
localVarQueryParameter['search_timeout_ms'] = searchTimeoutMs;
|
|
42015
|
+
}
|
|
42016
|
+
if (requireAllTerms !== undefined) {
|
|
42017
|
+
localVarQueryParameter['require_all_terms'] = requireAllTerms;
|
|
42018
|
+
}
|
|
42019
|
+
if (exactMatchBoost !== undefined) {
|
|
42020
|
+
localVarQueryParameter['exact_match_boost'] = exactMatchBoost;
|
|
42021
|
+
}
|
|
42022
|
+
if (cacheResults !== undefined) {
|
|
42023
|
+
localVarQueryParameter['cache_results'] = cacheResults;
|
|
42024
|
+
}
|
|
42025
|
+
if (applyRules !== undefined) {
|
|
42026
|
+
localVarQueryParameter['apply_rules'] = applyRules;
|
|
42027
|
+
}
|
|
42028
|
+
if (presetName !== undefined) {
|
|
42029
|
+
localVarQueryParameter['preset_name'] = presetName;
|
|
42030
|
+
}
|
|
42031
|
+
if (facetSearchText !== undefined) {
|
|
42032
|
+
localVarQueryParameter['facet_search_text'] = facetSearchText;
|
|
42033
|
+
}
|
|
42034
|
+
if (xStoreid != null) {
|
|
42035
|
+
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
42036
|
+
}
|
|
42037
|
+
if (xStoresecret != null) {
|
|
42038
|
+
localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
|
|
42039
|
+
}
|
|
42040
|
+
if (xUserId != null) {
|
|
42041
|
+
localVarHeaderParameter['x-user-id'] = String(xUserId);
|
|
42042
|
+
}
|
|
42043
|
+
if (xAnonId != null) {
|
|
42044
|
+
localVarHeaderParameter['x-anon-id'] = String(xAnonId);
|
|
42045
|
+
}
|
|
42046
|
+
if (xSessionId != null) {
|
|
42047
|
+
localVarHeaderParameter['x-session-id'] = String(xSessionId);
|
|
42048
|
+
}
|
|
42049
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
42050
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
42051
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
42052
|
+
return {
|
|
42053
|
+
url: toPathString(localVarUrlObj),
|
|
42054
|
+
options: localVarRequestOptions,
|
|
42055
|
+
};
|
|
42056
|
+
}),
|
|
41791
42057
|
/**
|
|
41792
42058
|
* Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
|
|
41793
42059
|
* @summary Public Search API
|
|
@@ -41951,6 +42217,64 @@ export const SearchApiFp = function (configuration) {
|
|
|
41951
42217
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
41952
42218
|
});
|
|
41953
42219
|
},
|
|
42220
|
+
/**
|
|
42221
|
+
* Search documents using query parameters. Supports all features of POST endpoint.
|
|
42222
|
+
* @summary Public Search API (GET)
|
|
42223
|
+
* @param {string} xStoreid Store ID
|
|
42224
|
+
* @param {string} xStoresecret Store Secret
|
|
42225
|
+
* @param {string} q Search query
|
|
42226
|
+
* @param {string} [xUserId] User ID for personalization
|
|
42227
|
+
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
42228
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
42229
|
+
* @param {number} [page] Page number (default: 1)
|
|
42230
|
+
* @param {number} [perPage] Items per page (default: 10)
|
|
42231
|
+
* @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
|
|
42232
|
+
* @param {string} [filterBy] Filter string (e.g., category:shirts)
|
|
42233
|
+
* @param {string} [facetBy] Facet fields (comma-separated)
|
|
42234
|
+
* @param {number} [maxFacetValues] Maximum facet values to return
|
|
42235
|
+
* @param {boolean} [widgetMode] Return widget-formatted results
|
|
42236
|
+
* @param {boolean} [includeSuggestions] Include autocomplete suggestions
|
|
42237
|
+
* @param {number} [suggestionsLimit] Number of suggestions to return
|
|
42238
|
+
* @param {string} [analyticsTags] Analytics tags (comma-separated)
|
|
42239
|
+
* @param {string} [stopwordSets] Stopword set IDs (comma-separated)
|
|
42240
|
+
* @param {string} [synonymSets] Synonym set IDs (comma-separated)
|
|
42241
|
+
* @param {string} [searchFields] Fields to search in (comma-separated)
|
|
42242
|
+
* @param {string} [returnFields] Fields to return (comma-separated)
|
|
42243
|
+
* @param {string} [omitFields] Fields to omit (comma-separated)
|
|
42244
|
+
* @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
|
|
42245
|
+
* @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
|
|
42246
|
+
* @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
|
|
42247
|
+
* @param {string} [groupField] Field to group results by
|
|
42248
|
+
* @param {number} [groupSize] Number of results per group
|
|
42249
|
+
* @param {string} [snippetPrefix] Prefix for highlighted snippets
|
|
42250
|
+
* @param {string} [snippetSuffix] Suffix for highlighted snippets
|
|
42251
|
+
* @param {number} [snippetTokenLimit] Maximum tokens in snippet
|
|
42252
|
+
* @param {number} [snippetMinLen] Minimum snippet length
|
|
42253
|
+
* @param {boolean} [includeSnippets] Include snippets in results
|
|
42254
|
+
* @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
|
|
42255
|
+
* @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
|
|
42256
|
+
* @param {number} [typoMax] Maximum typo tolerance
|
|
42257
|
+
* @param {number} [typoMinLen1] Min word length for 1 typo
|
|
42258
|
+
* @param {number} [typoMinLen2] Min word length for 2 typos
|
|
42259
|
+
* @param {number} [searchTimeoutMs] Search timeout in milliseconds
|
|
42260
|
+
* @param {boolean} [requireAllTerms] Require all search terms to match
|
|
42261
|
+
* @param {boolean} [exactMatchBoost] Boost exact matches
|
|
42262
|
+
* @param {boolean} [cacheResults] Cache search results
|
|
42263
|
+
* @param {boolean} [applyRules] Apply search rules
|
|
42264
|
+
* @param {string} [presetName] Search preset name to use
|
|
42265
|
+
* @param {string} [facetSearchText] Text to filter facet values
|
|
42266
|
+
* @param {*} [options] Override http request option.
|
|
42267
|
+
* @throws {RequiredError}
|
|
42268
|
+
*/
|
|
42269
|
+
v1SearchGet(xStoreid, xStoresecret, q, xUserId, xAnonId, xSessionId, page, perPage, sortBy, filterBy, facetBy, maxFacetValues, widgetMode, includeSuggestions, suggestionsLimit, analyticsTags, stopwordSets, synonymSets, searchFields, returnFields, omitFields, snippetFields, fullSnippetFields, fieldWeights, groupField, groupSize, snippetPrefix, snippetSuffix, snippetTokenLimit, snippetMinLen, includeSnippets, prefixMode, infixMode, typoMax, typoMinLen1, typoMinLen2, searchTimeoutMs, requireAllTerms, exactMatchBoost, cacheResults, applyRules, presetName, facetSearchText, options) {
|
|
42270
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
42271
|
+
var _a, _b, _c;
|
|
42272
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1SearchGet(xStoreid, xStoresecret, q, xUserId, xAnonId, xSessionId, page, perPage, sortBy, filterBy, facetBy, maxFacetValues, widgetMode, includeSuggestions, suggestionsLimit, analyticsTags, stopwordSets, synonymSets, searchFields, returnFields, omitFields, snippetFields, fullSnippetFields, fieldWeights, groupField, groupSize, snippetPrefix, snippetSuffix, snippetTokenLimit, snippetMinLen, includeSnippets, prefixMode, infixMode, typoMax, typoMinLen1, typoMinLen2, searchTimeoutMs, requireAllTerms, exactMatchBoost, cacheResults, applyRules, presetName, facetSearchText, options);
|
|
42273
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
42274
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['SearchApi.v1SearchGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
42275
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
42276
|
+
});
|
|
42277
|
+
},
|
|
41954
42278
|
/**
|
|
41955
42279
|
* Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
|
|
41956
42280
|
* @summary Public Search API
|
|
@@ -42045,6 +42369,58 @@ export const SearchApiFactory = function (configuration, basePath, axios) {
|
|
|
42045
42369
|
v1IndexIndexnameDefaultsGet(indexname, options) {
|
|
42046
42370
|
return localVarFp.v1IndexIndexnameDefaultsGet(indexname, options).then((request) => request(axios, basePath));
|
|
42047
42371
|
},
|
|
42372
|
+
/**
|
|
42373
|
+
* Search documents using query parameters. Supports all features of POST endpoint.
|
|
42374
|
+
* @summary Public Search API (GET)
|
|
42375
|
+
* @param {string} xStoreid Store ID
|
|
42376
|
+
* @param {string} xStoresecret Store Secret
|
|
42377
|
+
* @param {string} q Search query
|
|
42378
|
+
* @param {string} [xUserId] User ID for personalization
|
|
42379
|
+
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
42380
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
42381
|
+
* @param {number} [page] Page number (default: 1)
|
|
42382
|
+
* @param {number} [perPage] Items per page (default: 10)
|
|
42383
|
+
* @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
|
|
42384
|
+
* @param {string} [filterBy] Filter string (e.g., category:shirts)
|
|
42385
|
+
* @param {string} [facetBy] Facet fields (comma-separated)
|
|
42386
|
+
* @param {number} [maxFacetValues] Maximum facet values to return
|
|
42387
|
+
* @param {boolean} [widgetMode] Return widget-formatted results
|
|
42388
|
+
* @param {boolean} [includeSuggestions] Include autocomplete suggestions
|
|
42389
|
+
* @param {number} [suggestionsLimit] Number of suggestions to return
|
|
42390
|
+
* @param {string} [analyticsTags] Analytics tags (comma-separated)
|
|
42391
|
+
* @param {string} [stopwordSets] Stopword set IDs (comma-separated)
|
|
42392
|
+
* @param {string} [synonymSets] Synonym set IDs (comma-separated)
|
|
42393
|
+
* @param {string} [searchFields] Fields to search in (comma-separated)
|
|
42394
|
+
* @param {string} [returnFields] Fields to return (comma-separated)
|
|
42395
|
+
* @param {string} [omitFields] Fields to omit (comma-separated)
|
|
42396
|
+
* @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
|
|
42397
|
+
* @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
|
|
42398
|
+
* @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
|
|
42399
|
+
* @param {string} [groupField] Field to group results by
|
|
42400
|
+
* @param {number} [groupSize] Number of results per group
|
|
42401
|
+
* @param {string} [snippetPrefix] Prefix for highlighted snippets
|
|
42402
|
+
* @param {string} [snippetSuffix] Suffix for highlighted snippets
|
|
42403
|
+
* @param {number} [snippetTokenLimit] Maximum tokens in snippet
|
|
42404
|
+
* @param {number} [snippetMinLen] Minimum snippet length
|
|
42405
|
+
* @param {boolean} [includeSnippets] Include snippets in results
|
|
42406
|
+
* @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
|
|
42407
|
+
* @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
|
|
42408
|
+
* @param {number} [typoMax] Maximum typo tolerance
|
|
42409
|
+
* @param {number} [typoMinLen1] Min word length for 1 typo
|
|
42410
|
+
* @param {number} [typoMinLen2] Min word length for 2 typos
|
|
42411
|
+
* @param {number} [searchTimeoutMs] Search timeout in milliseconds
|
|
42412
|
+
* @param {boolean} [requireAllTerms] Require all search terms to match
|
|
42413
|
+
* @param {boolean} [exactMatchBoost] Boost exact matches
|
|
42414
|
+
* @param {boolean} [cacheResults] Cache search results
|
|
42415
|
+
* @param {boolean} [applyRules] Apply search rules
|
|
42416
|
+
* @param {string} [presetName] Search preset name to use
|
|
42417
|
+
* @param {string} [facetSearchText] Text to filter facet values
|
|
42418
|
+
* @param {*} [options] Override http request option.
|
|
42419
|
+
* @throws {RequiredError}
|
|
42420
|
+
*/
|
|
42421
|
+
v1SearchGet(xStoreid, xStoresecret, q, xUserId, xAnonId, xSessionId, page, perPage, sortBy, filterBy, facetBy, maxFacetValues, widgetMode, includeSuggestions, suggestionsLimit, analyticsTags, stopwordSets, synonymSets, searchFields, returnFields, omitFields, snippetFields, fullSnippetFields, fieldWeights, groupField, groupSize, snippetPrefix, snippetSuffix, snippetTokenLimit, snippetMinLen, includeSnippets, prefixMode, infixMode, typoMax, typoMinLen1, typoMinLen2, searchTimeoutMs, requireAllTerms, exactMatchBoost, cacheResults, applyRules, presetName, facetSearchText, options) {
|
|
42422
|
+
return localVarFp.v1SearchGet(xStoreid, xStoresecret, q, xUserId, xAnonId, xSessionId, page, perPage, sortBy, filterBy, facetBy, maxFacetValues, widgetMode, includeSuggestions, suggestionsLimit, analyticsTags, stopwordSets, synonymSets, searchFields, returnFields, omitFields, snippetFields, fullSnippetFields, fieldWeights, groupField, groupSize, snippetPrefix, snippetSuffix, snippetTokenLimit, snippetMinLen, includeSnippets, prefixMode, infixMode, typoMax, typoMinLen1, typoMinLen2, searchTimeoutMs, requireAllTerms, exactMatchBoost, cacheResults, applyRules, presetName, facetSearchText, options).then((request) => request(axios, basePath));
|
|
42423
|
+
},
|
|
42048
42424
|
/**
|
|
42049
42425
|
* Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
|
|
42050
42426
|
* @summary Public Search API
|
|
@@ -42139,6 +42515,59 @@ export class SearchApi extends BaseAPI {
|
|
|
42139
42515
|
v1IndexIndexnameDefaultsGet(indexname, options) {
|
|
42140
42516
|
return SearchApiFp(this.configuration).v1IndexIndexnameDefaultsGet(indexname, options).then((request) => request(this.axios, this.basePath));
|
|
42141
42517
|
}
|
|
42518
|
+
/**
|
|
42519
|
+
* Search documents using query parameters. Supports all features of POST endpoint.
|
|
42520
|
+
* @summary Public Search API (GET)
|
|
42521
|
+
* @param {string} xStoreid Store ID
|
|
42522
|
+
* @param {string} xStoresecret Store Secret
|
|
42523
|
+
* @param {string} q Search query
|
|
42524
|
+
* @param {string} [xUserId] User ID for personalization
|
|
42525
|
+
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
42526
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
42527
|
+
* @param {number} [page] Page number (default: 1)
|
|
42528
|
+
* @param {number} [perPage] Items per page (default: 10)
|
|
42529
|
+
* @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
|
|
42530
|
+
* @param {string} [filterBy] Filter string (e.g., category:shirts)
|
|
42531
|
+
* @param {string} [facetBy] Facet fields (comma-separated)
|
|
42532
|
+
* @param {number} [maxFacetValues] Maximum facet values to return
|
|
42533
|
+
* @param {boolean} [widgetMode] Return widget-formatted results
|
|
42534
|
+
* @param {boolean} [includeSuggestions] Include autocomplete suggestions
|
|
42535
|
+
* @param {number} [suggestionsLimit] Number of suggestions to return
|
|
42536
|
+
* @param {string} [analyticsTags] Analytics tags (comma-separated)
|
|
42537
|
+
* @param {string} [stopwordSets] Stopword set IDs (comma-separated)
|
|
42538
|
+
* @param {string} [synonymSets] Synonym set IDs (comma-separated)
|
|
42539
|
+
* @param {string} [searchFields] Fields to search in (comma-separated)
|
|
42540
|
+
* @param {string} [returnFields] Fields to return (comma-separated)
|
|
42541
|
+
* @param {string} [omitFields] Fields to omit (comma-separated)
|
|
42542
|
+
* @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
|
|
42543
|
+
* @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
|
|
42544
|
+
* @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
|
|
42545
|
+
* @param {string} [groupField] Field to group results by
|
|
42546
|
+
* @param {number} [groupSize] Number of results per group
|
|
42547
|
+
* @param {string} [snippetPrefix] Prefix for highlighted snippets
|
|
42548
|
+
* @param {string} [snippetSuffix] Suffix for highlighted snippets
|
|
42549
|
+
* @param {number} [snippetTokenLimit] Maximum tokens in snippet
|
|
42550
|
+
* @param {number} [snippetMinLen] Minimum snippet length
|
|
42551
|
+
* @param {boolean} [includeSnippets] Include snippets in results
|
|
42552
|
+
* @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
|
|
42553
|
+
* @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
|
|
42554
|
+
* @param {number} [typoMax] Maximum typo tolerance
|
|
42555
|
+
* @param {number} [typoMinLen1] Min word length for 1 typo
|
|
42556
|
+
* @param {number} [typoMinLen2] Min word length for 2 typos
|
|
42557
|
+
* @param {number} [searchTimeoutMs] Search timeout in milliseconds
|
|
42558
|
+
* @param {boolean} [requireAllTerms] Require all search terms to match
|
|
42559
|
+
* @param {boolean} [exactMatchBoost] Boost exact matches
|
|
42560
|
+
* @param {boolean} [cacheResults] Cache search results
|
|
42561
|
+
* @param {boolean} [applyRules] Apply search rules
|
|
42562
|
+
* @param {string} [presetName] Search preset name to use
|
|
42563
|
+
* @param {string} [facetSearchText] Text to filter facet values
|
|
42564
|
+
* @param {*} [options] Override http request option.
|
|
42565
|
+
* @throws {RequiredError}
|
|
42566
|
+
* @memberof SearchApi
|
|
42567
|
+
*/
|
|
42568
|
+
v1SearchGet(xStoreid, xStoresecret, q, xUserId, xAnonId, xSessionId, page, perPage, sortBy, filterBy, facetBy, maxFacetValues, widgetMode, includeSuggestions, suggestionsLimit, analyticsTags, stopwordSets, synonymSets, searchFields, returnFields, omitFields, snippetFields, fullSnippetFields, fieldWeights, groupField, groupSize, snippetPrefix, snippetSuffix, snippetTokenLimit, snippetMinLen, includeSnippets, prefixMode, infixMode, typoMax, typoMinLen1, typoMinLen2, searchTimeoutMs, requireAllTerms, exactMatchBoost, cacheResults, applyRules, presetName, facetSearchText, options) {
|
|
42569
|
+
return SearchApiFp(this.configuration).v1SearchGet(xStoreid, xStoresecret, q, xUserId, xAnonId, xSessionId, page, perPage, sortBy, filterBy, facetBy, maxFacetValues, widgetMode, includeSuggestions, suggestionsLimit, analyticsTags, stopwordSets, synonymSets, searchFields, returnFields, omitFields, snippetFields, fullSnippetFields, fieldWeights, groupField, groupSize, snippetPrefix, snippetSuffix, snippetTokenLimit, snippetMinLen, includeSnippets, prefixMode, infixMode, typoMax, typoMinLen1, typoMinLen2, searchTimeoutMs, requireAllTerms, exactMatchBoost, cacheResults, applyRules, presetName, facetSearchText, options).then((request) => request(this.axios, this.basePath));
|
|
42570
|
+
}
|
|
42142
42571
|
/**
|
|
42143
42572
|
* Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
|
|
42144
42573
|
* @summary Public Search API
|