@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/api.js
CHANGED
|
@@ -35113,29 +35113,38 @@ const QuerySuggestionsApiAxiosParamCreator = function (configuration) {
|
|
|
35113
35113
|
};
|
|
35114
35114
|
}),
|
|
35115
35115
|
/**
|
|
35116
|
-
* Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering,
|
|
35116
|
+
* 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.
|
|
35117
35117
|
* @summary Get Query Suggestions
|
|
35118
35118
|
* @param {string} xStoreid Store ID
|
|
35119
35119
|
* @param {string} xStoresecret Store Secret
|
|
35120
35120
|
* @param {string} [xUserId] User ID for personalization (logged-in user)
|
|
35121
35121
|
* @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
|
|
35122
35122
|
* @param {string} [xSessionId] Session ID for personalization
|
|
35123
|
-
* @param {string} [query] Partial query to get suggestions for
|
|
35123
|
+
* @param {string} [query] Partial query to get suggestions for (supports both \'query\' and \'q\')
|
|
35124
|
+
* @param {string} [q] Alias for \'query\' parameter
|
|
35124
35125
|
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
35125
35126
|
* @param {number} [page] Page number for pagination
|
|
35126
35127
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
|
|
35127
35128
|
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
|
|
35128
35129
|
* @param {boolean} [includeCategories] Include category information in suggestions
|
|
35129
35130
|
* @param {boolean} [includeFacets] Include popular facets/filters information
|
|
35131
|
+
* @param {boolean} [includeDropdownRecommendations] Include rich dropdown recommendations (trending products, filtered tabs)
|
|
35132
|
+
* @param {boolean} [includeDropdownProductList] Include product list in dropdown recommendations
|
|
35133
|
+
* @param {boolean} [includeFilteredTabs] Include filtered tabs in dropdown recommendations
|
|
35134
|
+
* @param {boolean} [includeEmptyQueryRecommendations] Return popular suggestions when query is empty
|
|
35130
35135
|
* @param {number} [maxCategories] Maximum categories per suggestion
|
|
35131
35136
|
* @param {number} [maxFacets] Maximum facets per suggestion
|
|
35132
35137
|
* @param {number} [minPopularity] Minimum popularity threshold
|
|
35133
35138
|
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
|
|
35134
35139
|
* @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
|
|
35140
|
+
* @param {string} [filteredTabs] URL-encoded JSON array of filtered tab configurations (e.g., [{\\
|
|
35141
|
+
* @param {string} [userId] User ID for personalization (query param fallback, header takes precedence)
|
|
35142
|
+
* @param {string} [anonId] Anonymous ID for personalization (query param fallback, header takes precedence)
|
|
35143
|
+
* @param {string} [sessionId] Session ID for personalization (query param fallback, header takes precedence)
|
|
35135
35144
|
* @param {*} [options] Override http request option.
|
|
35136
35145
|
* @throws {RequiredError}
|
|
35137
35146
|
*/
|
|
35138
|
-
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 = {}) {
|
|
35147
|
+
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 = {}) {
|
|
35139
35148
|
// verify required parameter 'xStoreid' is not null or undefined
|
|
35140
35149
|
(0, common_1.assertParamExists)('v1SuggestionsQueriesGet', 'xStoreid', xStoreid);
|
|
35141
35150
|
// verify required parameter 'xStoresecret' is not null or undefined
|
|
@@ -35153,6 +35162,9 @@ const QuerySuggestionsApiAxiosParamCreator = function (configuration) {
|
|
|
35153
35162
|
if (query !== undefined) {
|
|
35154
35163
|
localVarQueryParameter['query'] = query;
|
|
35155
35164
|
}
|
|
35165
|
+
if (q !== undefined) {
|
|
35166
|
+
localVarQueryParameter['q'] = q;
|
|
35167
|
+
}
|
|
35156
35168
|
if (hitsPerPage !== undefined) {
|
|
35157
35169
|
localVarQueryParameter['hitsPerPage'] = hitsPerPage;
|
|
35158
35170
|
}
|
|
@@ -35171,6 +35183,18 @@ const QuerySuggestionsApiAxiosParamCreator = function (configuration) {
|
|
|
35171
35183
|
if (includeFacets !== undefined) {
|
|
35172
35184
|
localVarQueryParameter['include_facets'] = includeFacets;
|
|
35173
35185
|
}
|
|
35186
|
+
if (includeDropdownRecommendations !== undefined) {
|
|
35187
|
+
localVarQueryParameter['include_dropdown_recommendations'] = includeDropdownRecommendations;
|
|
35188
|
+
}
|
|
35189
|
+
if (includeDropdownProductList !== undefined) {
|
|
35190
|
+
localVarQueryParameter['include_dropdown_product_list'] = includeDropdownProductList;
|
|
35191
|
+
}
|
|
35192
|
+
if (includeFilteredTabs !== undefined) {
|
|
35193
|
+
localVarQueryParameter['include_filtered_tabs'] = includeFilteredTabs;
|
|
35194
|
+
}
|
|
35195
|
+
if (includeEmptyQueryRecommendations !== undefined) {
|
|
35196
|
+
localVarQueryParameter['include_empty_query_recommendations'] = includeEmptyQueryRecommendations;
|
|
35197
|
+
}
|
|
35174
35198
|
if (maxCategories !== undefined) {
|
|
35175
35199
|
localVarQueryParameter['max_categories'] = maxCategories;
|
|
35176
35200
|
}
|
|
@@ -35186,6 +35210,18 @@ const QuerySuggestionsApiAxiosParamCreator = function (configuration) {
|
|
|
35186
35210
|
if (disableTypoTolerance !== undefined) {
|
|
35187
35211
|
localVarQueryParameter['disable_typo_tolerance'] = disableTypoTolerance;
|
|
35188
35212
|
}
|
|
35213
|
+
if (filteredTabs !== undefined) {
|
|
35214
|
+
localVarQueryParameter['filtered_tabs'] = filteredTabs;
|
|
35215
|
+
}
|
|
35216
|
+
if (userId !== undefined) {
|
|
35217
|
+
localVarQueryParameter['user_id'] = userId;
|
|
35218
|
+
}
|
|
35219
|
+
if (anonId !== undefined) {
|
|
35220
|
+
localVarQueryParameter['anon_id'] = anonId;
|
|
35221
|
+
}
|
|
35222
|
+
if (sessionId !== undefined) {
|
|
35223
|
+
localVarQueryParameter['session_id'] = sessionId;
|
|
35224
|
+
}
|
|
35189
35225
|
if (xStoreid != null) {
|
|
35190
35226
|
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
35191
35227
|
}
|
|
@@ -35210,14 +35246,14 @@ const QuerySuggestionsApiAxiosParamCreator = function (configuration) {
|
|
|
35210
35246
|
};
|
|
35211
35247
|
}),
|
|
35212
35248
|
/**
|
|
35213
|
-
* Same as GET
|
|
35249
|
+
* 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.
|
|
35214
35250
|
* @summary Post Query Suggestions
|
|
35215
35251
|
* @param {string} xStoreid Store ID
|
|
35216
35252
|
* @param {string} xStoresecret Store Secret
|
|
35217
35253
|
* @param {string} [xUserId] User ID for personalization (logged-in user)
|
|
35218
35254
|
* @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
|
|
35219
35255
|
* @param {string} [xSessionId] Session ID for personalization
|
|
35220
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, filtered_tabs, etc.)
|
|
35256
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, include_dropdown_recommendations, filtered_tabs, etc.)
|
|
35221
35257
|
* @param {*} [options] Override http request option.
|
|
35222
35258
|
* @throws {RequiredError}
|
|
35223
35259
|
*/
|
|
@@ -35289,46 +35325,55 @@ const QuerySuggestionsApiFp = function (configuration) {
|
|
|
35289
35325
|
});
|
|
35290
35326
|
},
|
|
35291
35327
|
/**
|
|
35292
|
-
* Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering,
|
|
35328
|
+
* 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.
|
|
35293
35329
|
* @summary Get Query Suggestions
|
|
35294
35330
|
* @param {string} xStoreid Store ID
|
|
35295
35331
|
* @param {string} xStoresecret Store Secret
|
|
35296
35332
|
* @param {string} [xUserId] User ID for personalization (logged-in user)
|
|
35297
35333
|
* @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
|
|
35298
35334
|
* @param {string} [xSessionId] Session ID for personalization
|
|
35299
|
-
* @param {string} [query] Partial query to get suggestions for
|
|
35335
|
+
* @param {string} [query] Partial query to get suggestions for (supports both \'query\' and \'q\')
|
|
35336
|
+
* @param {string} [q] Alias for \'query\' parameter
|
|
35300
35337
|
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
35301
35338
|
* @param {number} [page] Page number for pagination
|
|
35302
35339
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
|
|
35303
35340
|
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
|
|
35304
35341
|
* @param {boolean} [includeCategories] Include category information in suggestions
|
|
35305
35342
|
* @param {boolean} [includeFacets] Include popular facets/filters information
|
|
35343
|
+
* @param {boolean} [includeDropdownRecommendations] Include rich dropdown recommendations (trending products, filtered tabs)
|
|
35344
|
+
* @param {boolean} [includeDropdownProductList] Include product list in dropdown recommendations
|
|
35345
|
+
* @param {boolean} [includeFilteredTabs] Include filtered tabs in dropdown recommendations
|
|
35346
|
+
* @param {boolean} [includeEmptyQueryRecommendations] Return popular suggestions when query is empty
|
|
35306
35347
|
* @param {number} [maxCategories] Maximum categories per suggestion
|
|
35307
35348
|
* @param {number} [maxFacets] Maximum facets per suggestion
|
|
35308
35349
|
* @param {number} [minPopularity] Minimum popularity threshold
|
|
35309
35350
|
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
|
|
35310
35351
|
* @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
|
|
35352
|
+
* @param {string} [filteredTabs] URL-encoded JSON array of filtered tab configurations (e.g., [{\\
|
|
35353
|
+
* @param {string} [userId] User ID for personalization (query param fallback, header takes precedence)
|
|
35354
|
+
* @param {string} [anonId] Anonymous ID for personalization (query param fallback, header takes precedence)
|
|
35355
|
+
* @param {string} [sessionId] Session ID for personalization (query param fallback, header takes precedence)
|
|
35311
35356
|
* @param {*} [options] Override http request option.
|
|
35312
35357
|
* @throws {RequiredError}
|
|
35313
35358
|
*/
|
|
35314
|
-
v1SuggestionsQueriesGet(xStoreid, xStoresecret, xUserId, xAnonId, xSessionId, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options) {
|
|
35359
|
+
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) {
|
|
35315
35360
|
return __awaiter(this, void 0, void 0, function* () {
|
|
35316
35361
|
var _a, _b, _c;
|
|
35317
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1SuggestionsQueriesGet(xStoreid, xStoresecret, xUserId, xAnonId, xSessionId, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options);
|
|
35362
|
+
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);
|
|
35318
35363
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
35319
35364
|
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;
|
|
35320
35365
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
35321
35366
|
});
|
|
35322
35367
|
},
|
|
35323
35368
|
/**
|
|
35324
|
-
* Same as GET
|
|
35369
|
+
* 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.
|
|
35325
35370
|
* @summary Post Query Suggestions
|
|
35326
35371
|
* @param {string} xStoreid Store ID
|
|
35327
35372
|
* @param {string} xStoresecret Store Secret
|
|
35328
35373
|
* @param {string} [xUserId] User ID for personalization (logged-in user)
|
|
35329
35374
|
* @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
|
|
35330
35375
|
* @param {string} [xSessionId] Session ID for personalization
|
|
35331
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, filtered_tabs, etc.)
|
|
35376
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, include_dropdown_recommendations, filtered_tabs, etc.)
|
|
35332
35377
|
* @param {*} [options] Override http request option.
|
|
35333
35378
|
* @throws {RequiredError}
|
|
35334
35379
|
*/
|
|
@@ -35363,40 +35408,49 @@ const QuerySuggestionsApiFactory = function (configuration, basePath, axios) {
|
|
|
35363
35408
|
return localVarFp.v1SuggestionsConfigGet(xStoreid, xStoresecret, options).then((request) => request(axios, basePath));
|
|
35364
35409
|
},
|
|
35365
35410
|
/**
|
|
35366
|
-
* Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering,
|
|
35411
|
+
* 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.
|
|
35367
35412
|
* @summary Get Query Suggestions
|
|
35368
35413
|
* @param {string} xStoreid Store ID
|
|
35369
35414
|
* @param {string} xStoresecret Store Secret
|
|
35370
35415
|
* @param {string} [xUserId] User ID for personalization (logged-in user)
|
|
35371
35416
|
* @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
|
|
35372
35417
|
* @param {string} [xSessionId] Session ID for personalization
|
|
35373
|
-
* @param {string} [query] Partial query to get suggestions for
|
|
35418
|
+
* @param {string} [query] Partial query to get suggestions for (supports both \'query\' and \'q\')
|
|
35419
|
+
* @param {string} [q] Alias for \'query\' parameter
|
|
35374
35420
|
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
35375
35421
|
* @param {number} [page] Page number for pagination
|
|
35376
35422
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
|
|
35377
35423
|
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
|
|
35378
35424
|
* @param {boolean} [includeCategories] Include category information in suggestions
|
|
35379
35425
|
* @param {boolean} [includeFacets] Include popular facets/filters information
|
|
35426
|
+
* @param {boolean} [includeDropdownRecommendations] Include rich dropdown recommendations (trending products, filtered tabs)
|
|
35427
|
+
* @param {boolean} [includeDropdownProductList] Include product list in dropdown recommendations
|
|
35428
|
+
* @param {boolean} [includeFilteredTabs] Include filtered tabs in dropdown recommendations
|
|
35429
|
+
* @param {boolean} [includeEmptyQueryRecommendations] Return popular suggestions when query is empty
|
|
35380
35430
|
* @param {number} [maxCategories] Maximum categories per suggestion
|
|
35381
35431
|
* @param {number} [maxFacets] Maximum facets per suggestion
|
|
35382
35432
|
* @param {number} [minPopularity] Minimum popularity threshold
|
|
35383
35433
|
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
|
|
35384
35434
|
* @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
|
|
35435
|
+
* @param {string} [filteredTabs] URL-encoded JSON array of filtered tab configurations (e.g., [{\\
|
|
35436
|
+
* @param {string} [userId] User ID for personalization (query param fallback, header takes precedence)
|
|
35437
|
+
* @param {string} [anonId] Anonymous ID for personalization (query param fallback, header takes precedence)
|
|
35438
|
+
* @param {string} [sessionId] Session ID for personalization (query param fallback, header takes precedence)
|
|
35385
35439
|
* @param {*} [options] Override http request option.
|
|
35386
35440
|
* @throws {RequiredError}
|
|
35387
35441
|
*/
|
|
35388
|
-
v1SuggestionsQueriesGet(xStoreid, xStoresecret, xUserId, xAnonId, xSessionId, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options) {
|
|
35389
|
-
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));
|
|
35442
|
+
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) {
|
|
35443
|
+
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));
|
|
35390
35444
|
},
|
|
35391
35445
|
/**
|
|
35392
|
-
* Same as GET
|
|
35446
|
+
* 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.
|
|
35393
35447
|
* @summary Post Query Suggestions
|
|
35394
35448
|
* @param {string} xStoreid Store ID
|
|
35395
35449
|
* @param {string} xStoresecret Store Secret
|
|
35396
35450
|
* @param {string} [xUserId] User ID for personalization (logged-in user)
|
|
35397
35451
|
* @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
|
|
35398
35452
|
* @param {string} [xSessionId] Session ID for personalization
|
|
35399
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, filtered_tabs, etc.)
|
|
35453
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, include_dropdown_recommendations, filtered_tabs, etc.)
|
|
35400
35454
|
* @param {*} [options] Override http request option.
|
|
35401
35455
|
* @throws {RequiredError}
|
|
35402
35456
|
*/
|
|
@@ -35426,41 +35480,50 @@ class QuerySuggestionsApi extends base_1.BaseAPI {
|
|
|
35426
35480
|
return (0, exports.QuerySuggestionsApiFp)(this.configuration).v1SuggestionsConfigGet(xStoreid, xStoresecret, options).then((request) => request(this.axios, this.basePath));
|
|
35427
35481
|
}
|
|
35428
35482
|
/**
|
|
35429
|
-
* Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering,
|
|
35483
|
+
* 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.
|
|
35430
35484
|
* @summary Get Query Suggestions
|
|
35431
35485
|
* @param {string} xStoreid Store ID
|
|
35432
35486
|
* @param {string} xStoresecret Store Secret
|
|
35433
35487
|
* @param {string} [xUserId] User ID for personalization (logged-in user)
|
|
35434
35488
|
* @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
|
|
35435
35489
|
* @param {string} [xSessionId] Session ID for personalization
|
|
35436
|
-
* @param {string} [query] Partial query to get suggestions for
|
|
35490
|
+
* @param {string} [query] Partial query to get suggestions for (supports both \'query\' and \'q\')
|
|
35491
|
+
* @param {string} [q] Alias for \'query\' parameter
|
|
35437
35492
|
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
35438
35493
|
* @param {number} [page] Page number for pagination
|
|
35439
35494
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
|
|
35440
35495
|
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
|
|
35441
35496
|
* @param {boolean} [includeCategories] Include category information in suggestions
|
|
35442
35497
|
* @param {boolean} [includeFacets] Include popular facets/filters information
|
|
35498
|
+
* @param {boolean} [includeDropdownRecommendations] Include rich dropdown recommendations (trending products, filtered tabs)
|
|
35499
|
+
* @param {boolean} [includeDropdownProductList] Include product list in dropdown recommendations
|
|
35500
|
+
* @param {boolean} [includeFilteredTabs] Include filtered tabs in dropdown recommendations
|
|
35501
|
+
* @param {boolean} [includeEmptyQueryRecommendations] Return popular suggestions when query is empty
|
|
35443
35502
|
* @param {number} [maxCategories] Maximum categories per suggestion
|
|
35444
35503
|
* @param {number} [maxFacets] Maximum facets per suggestion
|
|
35445
35504
|
* @param {number} [minPopularity] Minimum popularity threshold
|
|
35446
35505
|
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
|
|
35447
35506
|
* @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
|
|
35507
|
+
* @param {string} [filteredTabs] URL-encoded JSON array of filtered tab configurations (e.g., [{\\
|
|
35508
|
+
* @param {string} [userId] User ID for personalization (query param fallback, header takes precedence)
|
|
35509
|
+
* @param {string} [anonId] Anonymous ID for personalization (query param fallback, header takes precedence)
|
|
35510
|
+
* @param {string} [sessionId] Session ID for personalization (query param fallback, header takes precedence)
|
|
35448
35511
|
* @param {*} [options] Override http request option.
|
|
35449
35512
|
* @throws {RequiredError}
|
|
35450
35513
|
* @memberof QuerySuggestionsApi
|
|
35451
35514
|
*/
|
|
35452
|
-
v1SuggestionsQueriesGet(xStoreid, xStoresecret, xUserId, xAnonId, xSessionId, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options) {
|
|
35453
|
-
return (0, exports.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));
|
|
35515
|
+
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) {
|
|
35516
|
+
return (0, exports.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));
|
|
35454
35517
|
}
|
|
35455
35518
|
/**
|
|
35456
|
-
* Same as GET
|
|
35519
|
+
* 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.
|
|
35457
35520
|
* @summary Post Query Suggestions
|
|
35458
35521
|
* @param {string} xStoreid Store ID
|
|
35459
35522
|
* @param {string} xStoresecret Store Secret
|
|
35460
35523
|
* @param {string} [xUserId] User ID for personalization (logged-in user)
|
|
35461
35524
|
* @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
|
|
35462
35525
|
* @param {string} [xSessionId] Session ID for personalization
|
|
35463
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, filtered_tabs, etc.)
|
|
35526
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, include_dropdown_recommendations, filtered_tabs, etc.)
|
|
35464
35527
|
* @param {*} [options] Override http request option.
|
|
35465
35528
|
* @throws {RequiredError}
|
|
35466
35529
|
* @memberof QuerySuggestionsApi
|
|
@@ -42084,6 +42147,209 @@ const SearchApiAxiosParamCreator = function (configuration) {
|
|
|
42084
42147
|
options: localVarRequestOptions,
|
|
42085
42148
|
};
|
|
42086
42149
|
}),
|
|
42150
|
+
/**
|
|
42151
|
+
* Search documents using query parameters. Supports all features of POST endpoint.
|
|
42152
|
+
* @summary Public Search API (GET)
|
|
42153
|
+
* @param {string} xStoreid Store ID
|
|
42154
|
+
* @param {string} xStoresecret Store Secret
|
|
42155
|
+
* @param {string} q Search query
|
|
42156
|
+
* @param {string} [xUserId] User ID for personalization
|
|
42157
|
+
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
42158
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
42159
|
+
* @param {number} [page] Page number (default: 1)
|
|
42160
|
+
* @param {number} [perPage] Items per page (default: 10)
|
|
42161
|
+
* @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
|
|
42162
|
+
* @param {string} [filterBy] Filter string (e.g., category:shirts)
|
|
42163
|
+
* @param {string} [facetBy] Facet fields (comma-separated)
|
|
42164
|
+
* @param {number} [maxFacetValues] Maximum facet values to return
|
|
42165
|
+
* @param {boolean} [widgetMode] Return widget-formatted results
|
|
42166
|
+
* @param {boolean} [includeSuggestions] Include autocomplete suggestions
|
|
42167
|
+
* @param {number} [suggestionsLimit] Number of suggestions to return
|
|
42168
|
+
* @param {string} [analyticsTags] Analytics tags (comma-separated)
|
|
42169
|
+
* @param {string} [stopwordSets] Stopword set IDs (comma-separated)
|
|
42170
|
+
* @param {string} [synonymSets] Synonym set IDs (comma-separated)
|
|
42171
|
+
* @param {string} [searchFields] Fields to search in (comma-separated)
|
|
42172
|
+
* @param {string} [returnFields] Fields to return (comma-separated)
|
|
42173
|
+
* @param {string} [omitFields] Fields to omit (comma-separated)
|
|
42174
|
+
* @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
|
|
42175
|
+
* @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
|
|
42176
|
+
* @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
|
|
42177
|
+
* @param {string} [groupField] Field to group results by
|
|
42178
|
+
* @param {number} [groupSize] Number of results per group
|
|
42179
|
+
* @param {string} [snippetPrefix] Prefix for highlighted snippets
|
|
42180
|
+
* @param {string} [snippetSuffix] Suffix for highlighted snippets
|
|
42181
|
+
* @param {number} [snippetTokenLimit] Maximum tokens in snippet
|
|
42182
|
+
* @param {number} [snippetMinLen] Minimum snippet length
|
|
42183
|
+
* @param {boolean} [includeSnippets] Include snippets in results
|
|
42184
|
+
* @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
|
|
42185
|
+
* @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
|
|
42186
|
+
* @param {number} [typoMax] Maximum typo tolerance
|
|
42187
|
+
* @param {number} [typoMinLen1] Min word length for 1 typo
|
|
42188
|
+
* @param {number} [typoMinLen2] Min word length for 2 typos
|
|
42189
|
+
* @param {number} [searchTimeoutMs] Search timeout in milliseconds
|
|
42190
|
+
* @param {boolean} [requireAllTerms] Require all search terms to match
|
|
42191
|
+
* @param {boolean} [exactMatchBoost] Boost exact matches
|
|
42192
|
+
* @param {boolean} [cacheResults] Cache search results
|
|
42193
|
+
* @param {boolean} [applyRules] Apply search rules
|
|
42194
|
+
* @param {string} [presetName] Search preset name to use
|
|
42195
|
+
* @param {string} [facetSearchText] Text to filter facet values
|
|
42196
|
+
* @param {*} [options] Override http request option.
|
|
42197
|
+
* @throws {RequiredError}
|
|
42198
|
+
*/
|
|
42199
|
+
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 = {}) {
|
|
42200
|
+
// verify required parameter 'xStoreid' is not null or undefined
|
|
42201
|
+
(0, common_1.assertParamExists)('v1SearchGet', 'xStoreid', xStoreid);
|
|
42202
|
+
// verify required parameter 'xStoresecret' is not null or undefined
|
|
42203
|
+
(0, common_1.assertParamExists)('v1SearchGet', 'xStoresecret', xStoresecret);
|
|
42204
|
+
// verify required parameter 'q' is not null or undefined
|
|
42205
|
+
(0, common_1.assertParamExists)('v1SearchGet', 'q', q);
|
|
42206
|
+
const localVarPath = `/v1/search`;
|
|
42207
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
42208
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
42209
|
+
let baseOptions;
|
|
42210
|
+
if (configuration) {
|
|
42211
|
+
baseOptions = configuration.baseOptions;
|
|
42212
|
+
}
|
|
42213
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
42214
|
+
const localVarHeaderParameter = {};
|
|
42215
|
+
const localVarQueryParameter = {};
|
|
42216
|
+
if (q !== undefined) {
|
|
42217
|
+
localVarQueryParameter['q'] = q;
|
|
42218
|
+
}
|
|
42219
|
+
if (page !== undefined) {
|
|
42220
|
+
localVarQueryParameter['page'] = page;
|
|
42221
|
+
}
|
|
42222
|
+
if (perPage !== undefined) {
|
|
42223
|
+
localVarQueryParameter['per_page'] = perPage;
|
|
42224
|
+
}
|
|
42225
|
+
if (sortBy !== undefined) {
|
|
42226
|
+
localVarQueryParameter['sort_by'] = sortBy;
|
|
42227
|
+
}
|
|
42228
|
+
if (filterBy !== undefined) {
|
|
42229
|
+
localVarQueryParameter['filter_by'] = filterBy;
|
|
42230
|
+
}
|
|
42231
|
+
if (facetBy !== undefined) {
|
|
42232
|
+
localVarQueryParameter['facet_by'] = facetBy;
|
|
42233
|
+
}
|
|
42234
|
+
if (maxFacetValues !== undefined) {
|
|
42235
|
+
localVarQueryParameter['max_facet_values'] = maxFacetValues;
|
|
42236
|
+
}
|
|
42237
|
+
if (widgetMode !== undefined) {
|
|
42238
|
+
localVarQueryParameter['widget_mode'] = widgetMode;
|
|
42239
|
+
}
|
|
42240
|
+
if (includeSuggestions !== undefined) {
|
|
42241
|
+
localVarQueryParameter['include_suggestions'] = includeSuggestions;
|
|
42242
|
+
}
|
|
42243
|
+
if (suggestionsLimit !== undefined) {
|
|
42244
|
+
localVarQueryParameter['suggestions_limit'] = suggestionsLimit;
|
|
42245
|
+
}
|
|
42246
|
+
if (analyticsTags !== undefined) {
|
|
42247
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
42248
|
+
}
|
|
42249
|
+
if (stopwordSets !== undefined) {
|
|
42250
|
+
localVarQueryParameter['stopword_sets'] = stopwordSets;
|
|
42251
|
+
}
|
|
42252
|
+
if (synonymSets !== undefined) {
|
|
42253
|
+
localVarQueryParameter['synonym_sets'] = synonymSets;
|
|
42254
|
+
}
|
|
42255
|
+
if (searchFields !== undefined) {
|
|
42256
|
+
localVarQueryParameter['search_fields'] = searchFields;
|
|
42257
|
+
}
|
|
42258
|
+
if (returnFields !== undefined) {
|
|
42259
|
+
localVarQueryParameter['return_fields'] = returnFields;
|
|
42260
|
+
}
|
|
42261
|
+
if (omitFields !== undefined) {
|
|
42262
|
+
localVarQueryParameter['omit_fields'] = omitFields;
|
|
42263
|
+
}
|
|
42264
|
+
if (snippetFields !== undefined) {
|
|
42265
|
+
localVarQueryParameter['snippet_fields'] = snippetFields;
|
|
42266
|
+
}
|
|
42267
|
+
if (fullSnippetFields !== undefined) {
|
|
42268
|
+
localVarQueryParameter['full_snippet_fields'] = fullSnippetFields;
|
|
42269
|
+
}
|
|
42270
|
+
if (fieldWeights !== undefined) {
|
|
42271
|
+
localVarQueryParameter['field_weights'] = fieldWeights;
|
|
42272
|
+
}
|
|
42273
|
+
if (groupField !== undefined) {
|
|
42274
|
+
localVarQueryParameter['group_field'] = groupField;
|
|
42275
|
+
}
|
|
42276
|
+
if (groupSize !== undefined) {
|
|
42277
|
+
localVarQueryParameter['group_size'] = groupSize;
|
|
42278
|
+
}
|
|
42279
|
+
if (snippetPrefix !== undefined) {
|
|
42280
|
+
localVarQueryParameter['snippet_prefix'] = snippetPrefix;
|
|
42281
|
+
}
|
|
42282
|
+
if (snippetSuffix !== undefined) {
|
|
42283
|
+
localVarQueryParameter['snippet_suffix'] = snippetSuffix;
|
|
42284
|
+
}
|
|
42285
|
+
if (snippetTokenLimit !== undefined) {
|
|
42286
|
+
localVarQueryParameter['snippet_token_limit'] = snippetTokenLimit;
|
|
42287
|
+
}
|
|
42288
|
+
if (snippetMinLen !== undefined) {
|
|
42289
|
+
localVarQueryParameter['snippet_min_len'] = snippetMinLen;
|
|
42290
|
+
}
|
|
42291
|
+
if (includeSnippets !== undefined) {
|
|
42292
|
+
localVarQueryParameter['include_snippets'] = includeSnippets;
|
|
42293
|
+
}
|
|
42294
|
+
if (prefixMode !== undefined) {
|
|
42295
|
+
localVarQueryParameter['prefix_mode'] = prefixMode;
|
|
42296
|
+
}
|
|
42297
|
+
if (infixMode !== undefined) {
|
|
42298
|
+
localVarQueryParameter['infix_mode'] = infixMode;
|
|
42299
|
+
}
|
|
42300
|
+
if (typoMax !== undefined) {
|
|
42301
|
+
localVarQueryParameter['typo_max'] = typoMax;
|
|
42302
|
+
}
|
|
42303
|
+
if (typoMinLen1 !== undefined) {
|
|
42304
|
+
localVarQueryParameter['typo_min_len_1'] = typoMinLen1;
|
|
42305
|
+
}
|
|
42306
|
+
if (typoMinLen2 !== undefined) {
|
|
42307
|
+
localVarQueryParameter['typo_min_len_2'] = typoMinLen2;
|
|
42308
|
+
}
|
|
42309
|
+
if (searchTimeoutMs !== undefined) {
|
|
42310
|
+
localVarQueryParameter['search_timeout_ms'] = searchTimeoutMs;
|
|
42311
|
+
}
|
|
42312
|
+
if (requireAllTerms !== undefined) {
|
|
42313
|
+
localVarQueryParameter['require_all_terms'] = requireAllTerms;
|
|
42314
|
+
}
|
|
42315
|
+
if (exactMatchBoost !== undefined) {
|
|
42316
|
+
localVarQueryParameter['exact_match_boost'] = exactMatchBoost;
|
|
42317
|
+
}
|
|
42318
|
+
if (cacheResults !== undefined) {
|
|
42319
|
+
localVarQueryParameter['cache_results'] = cacheResults;
|
|
42320
|
+
}
|
|
42321
|
+
if (applyRules !== undefined) {
|
|
42322
|
+
localVarQueryParameter['apply_rules'] = applyRules;
|
|
42323
|
+
}
|
|
42324
|
+
if (presetName !== undefined) {
|
|
42325
|
+
localVarQueryParameter['preset_name'] = presetName;
|
|
42326
|
+
}
|
|
42327
|
+
if (facetSearchText !== undefined) {
|
|
42328
|
+
localVarQueryParameter['facet_search_text'] = facetSearchText;
|
|
42329
|
+
}
|
|
42330
|
+
if (xStoreid != null) {
|
|
42331
|
+
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
42332
|
+
}
|
|
42333
|
+
if (xStoresecret != null) {
|
|
42334
|
+
localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
|
|
42335
|
+
}
|
|
42336
|
+
if (xUserId != null) {
|
|
42337
|
+
localVarHeaderParameter['x-user-id'] = String(xUserId);
|
|
42338
|
+
}
|
|
42339
|
+
if (xAnonId != null) {
|
|
42340
|
+
localVarHeaderParameter['x-anon-id'] = String(xAnonId);
|
|
42341
|
+
}
|
|
42342
|
+
if (xSessionId != null) {
|
|
42343
|
+
localVarHeaderParameter['x-session-id'] = String(xSessionId);
|
|
42344
|
+
}
|
|
42345
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
42346
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
42347
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
42348
|
+
return {
|
|
42349
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
42350
|
+
options: localVarRequestOptions,
|
|
42351
|
+
};
|
|
42352
|
+
}),
|
|
42087
42353
|
/**
|
|
42088
42354
|
* 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.
|
|
42089
42355
|
* @summary Public Search API
|
|
@@ -42248,6 +42514,64 @@ const SearchApiFp = function (configuration) {
|
|
|
42248
42514
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
42249
42515
|
});
|
|
42250
42516
|
},
|
|
42517
|
+
/**
|
|
42518
|
+
* Search documents using query parameters. Supports all features of POST endpoint.
|
|
42519
|
+
* @summary Public Search API (GET)
|
|
42520
|
+
* @param {string} xStoreid Store ID
|
|
42521
|
+
* @param {string} xStoresecret Store Secret
|
|
42522
|
+
* @param {string} q Search query
|
|
42523
|
+
* @param {string} [xUserId] User ID for personalization
|
|
42524
|
+
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
42525
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
42526
|
+
* @param {number} [page] Page number (default: 1)
|
|
42527
|
+
* @param {number} [perPage] Items per page (default: 10)
|
|
42528
|
+
* @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
|
|
42529
|
+
* @param {string} [filterBy] Filter string (e.g., category:shirts)
|
|
42530
|
+
* @param {string} [facetBy] Facet fields (comma-separated)
|
|
42531
|
+
* @param {number} [maxFacetValues] Maximum facet values to return
|
|
42532
|
+
* @param {boolean} [widgetMode] Return widget-formatted results
|
|
42533
|
+
* @param {boolean} [includeSuggestions] Include autocomplete suggestions
|
|
42534
|
+
* @param {number} [suggestionsLimit] Number of suggestions to return
|
|
42535
|
+
* @param {string} [analyticsTags] Analytics tags (comma-separated)
|
|
42536
|
+
* @param {string} [stopwordSets] Stopword set IDs (comma-separated)
|
|
42537
|
+
* @param {string} [synonymSets] Synonym set IDs (comma-separated)
|
|
42538
|
+
* @param {string} [searchFields] Fields to search in (comma-separated)
|
|
42539
|
+
* @param {string} [returnFields] Fields to return (comma-separated)
|
|
42540
|
+
* @param {string} [omitFields] Fields to omit (comma-separated)
|
|
42541
|
+
* @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
|
|
42542
|
+
* @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
|
|
42543
|
+
* @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
|
|
42544
|
+
* @param {string} [groupField] Field to group results by
|
|
42545
|
+
* @param {number} [groupSize] Number of results per group
|
|
42546
|
+
* @param {string} [snippetPrefix] Prefix for highlighted snippets
|
|
42547
|
+
* @param {string} [snippetSuffix] Suffix for highlighted snippets
|
|
42548
|
+
* @param {number} [snippetTokenLimit] Maximum tokens in snippet
|
|
42549
|
+
* @param {number} [snippetMinLen] Minimum snippet length
|
|
42550
|
+
* @param {boolean} [includeSnippets] Include snippets in results
|
|
42551
|
+
* @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
|
|
42552
|
+
* @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
|
|
42553
|
+
* @param {number} [typoMax] Maximum typo tolerance
|
|
42554
|
+
* @param {number} [typoMinLen1] Min word length for 1 typo
|
|
42555
|
+
* @param {number} [typoMinLen2] Min word length for 2 typos
|
|
42556
|
+
* @param {number} [searchTimeoutMs] Search timeout in milliseconds
|
|
42557
|
+
* @param {boolean} [requireAllTerms] Require all search terms to match
|
|
42558
|
+
* @param {boolean} [exactMatchBoost] Boost exact matches
|
|
42559
|
+
* @param {boolean} [cacheResults] Cache search results
|
|
42560
|
+
* @param {boolean} [applyRules] Apply search rules
|
|
42561
|
+
* @param {string} [presetName] Search preset name to use
|
|
42562
|
+
* @param {string} [facetSearchText] Text to filter facet values
|
|
42563
|
+
* @param {*} [options] Override http request option.
|
|
42564
|
+
* @throws {RequiredError}
|
|
42565
|
+
*/
|
|
42566
|
+
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) {
|
|
42567
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
42568
|
+
var _a, _b, _c;
|
|
42569
|
+
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);
|
|
42570
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
42571
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['SearchApi.v1SearchGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
42572
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
42573
|
+
});
|
|
42574
|
+
},
|
|
42251
42575
|
/**
|
|
42252
42576
|
* 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.
|
|
42253
42577
|
* @summary Public Search API
|
|
@@ -42343,6 +42667,58 @@ const SearchApiFactory = function (configuration, basePath, axios) {
|
|
|
42343
42667
|
v1IndexIndexnameDefaultsGet(indexname, options) {
|
|
42344
42668
|
return localVarFp.v1IndexIndexnameDefaultsGet(indexname, options).then((request) => request(axios, basePath));
|
|
42345
42669
|
},
|
|
42670
|
+
/**
|
|
42671
|
+
* Search documents using query parameters. Supports all features of POST endpoint.
|
|
42672
|
+
* @summary Public Search API (GET)
|
|
42673
|
+
* @param {string} xStoreid Store ID
|
|
42674
|
+
* @param {string} xStoresecret Store Secret
|
|
42675
|
+
* @param {string} q Search query
|
|
42676
|
+
* @param {string} [xUserId] User ID for personalization
|
|
42677
|
+
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
42678
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
42679
|
+
* @param {number} [page] Page number (default: 1)
|
|
42680
|
+
* @param {number} [perPage] Items per page (default: 10)
|
|
42681
|
+
* @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
|
|
42682
|
+
* @param {string} [filterBy] Filter string (e.g., category:shirts)
|
|
42683
|
+
* @param {string} [facetBy] Facet fields (comma-separated)
|
|
42684
|
+
* @param {number} [maxFacetValues] Maximum facet values to return
|
|
42685
|
+
* @param {boolean} [widgetMode] Return widget-formatted results
|
|
42686
|
+
* @param {boolean} [includeSuggestions] Include autocomplete suggestions
|
|
42687
|
+
* @param {number} [suggestionsLimit] Number of suggestions to return
|
|
42688
|
+
* @param {string} [analyticsTags] Analytics tags (comma-separated)
|
|
42689
|
+
* @param {string} [stopwordSets] Stopword set IDs (comma-separated)
|
|
42690
|
+
* @param {string} [synonymSets] Synonym set IDs (comma-separated)
|
|
42691
|
+
* @param {string} [searchFields] Fields to search in (comma-separated)
|
|
42692
|
+
* @param {string} [returnFields] Fields to return (comma-separated)
|
|
42693
|
+
* @param {string} [omitFields] Fields to omit (comma-separated)
|
|
42694
|
+
* @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
|
|
42695
|
+
* @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
|
|
42696
|
+
* @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
|
|
42697
|
+
* @param {string} [groupField] Field to group results by
|
|
42698
|
+
* @param {number} [groupSize] Number of results per group
|
|
42699
|
+
* @param {string} [snippetPrefix] Prefix for highlighted snippets
|
|
42700
|
+
* @param {string} [snippetSuffix] Suffix for highlighted snippets
|
|
42701
|
+
* @param {number} [snippetTokenLimit] Maximum tokens in snippet
|
|
42702
|
+
* @param {number} [snippetMinLen] Minimum snippet length
|
|
42703
|
+
* @param {boolean} [includeSnippets] Include snippets in results
|
|
42704
|
+
* @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
|
|
42705
|
+
* @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
|
|
42706
|
+
* @param {number} [typoMax] Maximum typo tolerance
|
|
42707
|
+
* @param {number} [typoMinLen1] Min word length for 1 typo
|
|
42708
|
+
* @param {number} [typoMinLen2] Min word length for 2 typos
|
|
42709
|
+
* @param {number} [searchTimeoutMs] Search timeout in milliseconds
|
|
42710
|
+
* @param {boolean} [requireAllTerms] Require all search terms to match
|
|
42711
|
+
* @param {boolean} [exactMatchBoost] Boost exact matches
|
|
42712
|
+
* @param {boolean} [cacheResults] Cache search results
|
|
42713
|
+
* @param {boolean} [applyRules] Apply search rules
|
|
42714
|
+
* @param {string} [presetName] Search preset name to use
|
|
42715
|
+
* @param {string} [facetSearchText] Text to filter facet values
|
|
42716
|
+
* @param {*} [options] Override http request option.
|
|
42717
|
+
* @throws {RequiredError}
|
|
42718
|
+
*/
|
|
42719
|
+
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) {
|
|
42720
|
+
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));
|
|
42721
|
+
},
|
|
42346
42722
|
/**
|
|
42347
42723
|
* 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.
|
|
42348
42724
|
* @summary Public Search API
|
|
@@ -42438,6 +42814,59 @@ class SearchApi extends base_1.BaseAPI {
|
|
|
42438
42814
|
v1IndexIndexnameDefaultsGet(indexname, options) {
|
|
42439
42815
|
return (0, exports.SearchApiFp)(this.configuration).v1IndexIndexnameDefaultsGet(indexname, options).then((request) => request(this.axios, this.basePath));
|
|
42440
42816
|
}
|
|
42817
|
+
/**
|
|
42818
|
+
* Search documents using query parameters. Supports all features of POST endpoint.
|
|
42819
|
+
* @summary Public Search API (GET)
|
|
42820
|
+
* @param {string} xStoreid Store ID
|
|
42821
|
+
* @param {string} xStoresecret Store Secret
|
|
42822
|
+
* @param {string} q Search query
|
|
42823
|
+
* @param {string} [xUserId] User ID for personalization
|
|
42824
|
+
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
42825
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
42826
|
+
* @param {number} [page] Page number (default: 1)
|
|
42827
|
+
* @param {number} [perPage] Items per page (default: 10)
|
|
42828
|
+
* @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
|
|
42829
|
+
* @param {string} [filterBy] Filter string (e.g., category:shirts)
|
|
42830
|
+
* @param {string} [facetBy] Facet fields (comma-separated)
|
|
42831
|
+
* @param {number} [maxFacetValues] Maximum facet values to return
|
|
42832
|
+
* @param {boolean} [widgetMode] Return widget-formatted results
|
|
42833
|
+
* @param {boolean} [includeSuggestions] Include autocomplete suggestions
|
|
42834
|
+
* @param {number} [suggestionsLimit] Number of suggestions to return
|
|
42835
|
+
* @param {string} [analyticsTags] Analytics tags (comma-separated)
|
|
42836
|
+
* @param {string} [stopwordSets] Stopword set IDs (comma-separated)
|
|
42837
|
+
* @param {string} [synonymSets] Synonym set IDs (comma-separated)
|
|
42838
|
+
* @param {string} [searchFields] Fields to search in (comma-separated)
|
|
42839
|
+
* @param {string} [returnFields] Fields to return (comma-separated)
|
|
42840
|
+
* @param {string} [omitFields] Fields to omit (comma-separated)
|
|
42841
|
+
* @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
|
|
42842
|
+
* @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
|
|
42843
|
+
* @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
|
|
42844
|
+
* @param {string} [groupField] Field to group results by
|
|
42845
|
+
* @param {number} [groupSize] Number of results per group
|
|
42846
|
+
* @param {string} [snippetPrefix] Prefix for highlighted snippets
|
|
42847
|
+
* @param {string} [snippetSuffix] Suffix for highlighted snippets
|
|
42848
|
+
* @param {number} [snippetTokenLimit] Maximum tokens in snippet
|
|
42849
|
+
* @param {number} [snippetMinLen] Minimum snippet length
|
|
42850
|
+
* @param {boolean} [includeSnippets] Include snippets in results
|
|
42851
|
+
* @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
|
|
42852
|
+
* @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
|
|
42853
|
+
* @param {number} [typoMax] Maximum typo tolerance
|
|
42854
|
+
* @param {number} [typoMinLen1] Min word length for 1 typo
|
|
42855
|
+
* @param {number} [typoMinLen2] Min word length for 2 typos
|
|
42856
|
+
* @param {number} [searchTimeoutMs] Search timeout in milliseconds
|
|
42857
|
+
* @param {boolean} [requireAllTerms] Require all search terms to match
|
|
42858
|
+
* @param {boolean} [exactMatchBoost] Boost exact matches
|
|
42859
|
+
* @param {boolean} [cacheResults] Cache search results
|
|
42860
|
+
* @param {boolean} [applyRules] Apply search rules
|
|
42861
|
+
* @param {string} [presetName] Search preset name to use
|
|
42862
|
+
* @param {string} [facetSearchText] Text to filter facet values
|
|
42863
|
+
* @param {*} [options] Override http request option.
|
|
42864
|
+
* @throws {RequiredError}
|
|
42865
|
+
* @memberof SearchApi
|
|
42866
|
+
*/
|
|
42867
|
+
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) {
|
|
42868
|
+
return (0, exports.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));
|
|
42869
|
+
}
|
|
42441
42870
|
/**
|
|
42442
42871
|
* 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.
|
|
42443
42872
|
* @summary Public Search API
|