@seekora-ai/admin-api 1.1.79 → 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.79.tgz +0 -0
package/dist/esm/api.d.ts
CHANGED
|
@@ -12868,6 +12868,12 @@ export interface DataTypesCombinedSearchResponse {
|
|
|
12868
12868
|
* @memberof DataTypesCombinedSearchResponse
|
|
12869
12869
|
*/
|
|
12870
12870
|
'search_id'?: string;
|
|
12871
|
+
/**
|
|
12872
|
+
* Available sort options based on schema
|
|
12873
|
+
* @type {Array<DataTypesSortOption>}
|
|
12874
|
+
* @memberof DataTypesCombinedSearchResponse
|
|
12875
|
+
*/
|
|
12876
|
+
'sort_options'?: Array<DataTypesSortOption>;
|
|
12871
12877
|
/**
|
|
12872
12878
|
*
|
|
12873
12879
|
* @type {Array<DataTypesAutocompleteSuggestion>}
|
|
@@ -15981,6 +15987,12 @@ export interface DataTypesEventPayload {
|
|
|
15981
15987
|
* @memberof DataTypesEventPayload
|
|
15982
15988
|
*/
|
|
15983
15989
|
'connection_type'?: string;
|
|
15990
|
+
/**
|
|
15991
|
+
* add_to_cart, wishlist, purchase, etc.
|
|
15992
|
+
* @type {string}
|
|
15993
|
+
* @memberof DataTypesEventPayload
|
|
15994
|
+
*/
|
|
15995
|
+
'conversion_type'?: string;
|
|
15984
15996
|
/**
|
|
15985
15997
|
*
|
|
15986
15998
|
* @type {string}
|
|
@@ -16059,6 +16071,12 @@ export interface DataTypesEventPayload {
|
|
|
16059
16071
|
* @memberof DataTypesEventPayload
|
|
16060
16072
|
*/
|
|
16061
16073
|
'impression_duration_ms'?: number;
|
|
16074
|
+
/**
|
|
16075
|
+
* Deduplication (industry standard: Segment, Amplitude, Mixpanel pattern) Format: {user_key}_{event_type}_{item_id}_{timestamp_window} Backend can deduplicate by this key within configurable window
|
|
16076
|
+
* @type {string}
|
|
16077
|
+
* @memberof DataTypesEventPayload
|
|
16078
|
+
*/
|
|
16079
|
+
'insert_id'?: string;
|
|
16062
16080
|
/**
|
|
16063
16081
|
* ============================================================================ Device Context (V3) ============================================================================
|
|
16064
16082
|
* @type {string}
|
|
@@ -16175,6 +16193,12 @@ export interface DataTypesEventPayload {
|
|
|
16175
16193
|
* @memberof DataTypesEventPayload
|
|
16176
16194
|
*/
|
|
16177
16195
|
'products_count'?: number;
|
|
16196
|
+
/**
|
|
16197
|
+
*
|
|
16198
|
+
* @type {number}
|
|
16199
|
+
* @memberof DataTypesEventPayload
|
|
16200
|
+
*/
|
|
16201
|
+
'quantity'?: number;
|
|
16178
16202
|
/**
|
|
16179
16203
|
* ============================================================================ Search Event Fields ============================================================================
|
|
16180
16204
|
* @type {string}
|
|
@@ -22770,6 +22794,12 @@ export interface DataTypesOfficialSearchResponse {
|
|
|
22770
22794
|
* @memberof DataTypesOfficialSearchResponse
|
|
22771
22795
|
*/
|
|
22772
22796
|
'search_id'?: string;
|
|
22797
|
+
/**
|
|
22798
|
+
* Available sort options based on schema
|
|
22799
|
+
* @type {Array<DataTypesSortOption>}
|
|
22800
|
+
* @memberof DataTypesOfficialSearchResponse
|
|
22801
|
+
*/
|
|
22802
|
+
'sort_options'?: Array<DataTypesSortOption>;
|
|
22773
22803
|
/**
|
|
22774
22804
|
*
|
|
22775
22805
|
* @type {Array<DataTypesAutocompleteSuggestion>}
|
|
@@ -23520,6 +23550,12 @@ export interface DataTypesOrgMemberWithUser {
|
|
|
23520
23550
|
* @memberof DataTypesOrgMemberWithUser
|
|
23521
23551
|
*/
|
|
23522
23552
|
'is_active'?: boolean;
|
|
23553
|
+
/**
|
|
23554
|
+
* True if user is the organization owner (non-deletable)
|
|
23555
|
+
* @type {boolean}
|
|
23556
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
23557
|
+
*/
|
|
23558
|
+
'is_owner'?: boolean;
|
|
23523
23559
|
/**
|
|
23524
23560
|
* True if user has custom/user-specific role
|
|
23525
23561
|
* @type {boolean}
|
|
@@ -26397,6 +26433,12 @@ export interface DataTypesRole {
|
|
|
26397
26433
|
* @memberof DataTypesRole
|
|
26398
26434
|
*/
|
|
26399
26435
|
'isDeleted'?: boolean;
|
|
26436
|
+
/**
|
|
26437
|
+
* BOOLEAN, DEFAULT FALSE - TRUE for system-created roles (non-editable)
|
|
26438
|
+
* @type {boolean}
|
|
26439
|
+
* @memberof DataTypesRole
|
|
26440
|
+
*/
|
|
26441
|
+
'isSystemCreated'?: boolean;
|
|
26400
26442
|
/**
|
|
26401
26443
|
* BOOLEAN, DEFAULT FALSE - TRUE for user-specific custom roles
|
|
26402
26444
|
* @type {boolean}
|
|
@@ -27836,6 +27878,37 @@ export interface DataTypesSortField {
|
|
|
27836
27878
|
*/
|
|
27837
27879
|
'field'?: string;
|
|
27838
27880
|
}
|
|
27881
|
+
/**
|
|
27882
|
+
*
|
|
27883
|
+
* @export
|
|
27884
|
+
* @interface DataTypesSortOption
|
|
27885
|
+
*/
|
|
27886
|
+
export interface DataTypesSortOption {
|
|
27887
|
+
/**
|
|
27888
|
+
* \"asc\" or \"desc\"
|
|
27889
|
+
* @type {string}
|
|
27890
|
+
* @memberof DataTypesSortOption
|
|
27891
|
+
*/
|
|
27892
|
+
'direction'?: string;
|
|
27893
|
+
/**
|
|
27894
|
+
* Field name (e.g., \"price\", \"created_at\")
|
|
27895
|
+
* @type {string}
|
|
27896
|
+
* @memberof DataTypesSortOption
|
|
27897
|
+
*/
|
|
27898
|
+
'field'?: string;
|
|
27899
|
+
/**
|
|
27900
|
+
* Human-readable label (e.g., \"Price: Low to High\")
|
|
27901
|
+
* @type {string}
|
|
27902
|
+
* @memberof DataTypesSortOption
|
|
27903
|
+
*/
|
|
27904
|
+
'label'?: string;
|
|
27905
|
+
/**
|
|
27906
|
+
* Combined value for API (e.g., \"price:asc\")
|
|
27907
|
+
* @type {string}
|
|
27908
|
+
* @memberof DataTypesSortOption
|
|
27909
|
+
*/
|
|
27910
|
+
'value'?: string;
|
|
27911
|
+
}
|
|
27839
27912
|
/**
|
|
27840
27913
|
*
|
|
27841
27914
|
* @export
|
|
@@ -35227,6 +35300,12 @@ export interface QuerySuggestionsServiceQuerySuggestionsRequest {
|
|
|
35227
35300
|
* @memberof QuerySuggestionsServiceQuerySuggestionsRequest
|
|
35228
35301
|
*/
|
|
35229
35302
|
'include_categories'?: boolean;
|
|
35303
|
+
/**
|
|
35304
|
+
* Optional: disable parts of dropdown when include_dropdown_recommendations=true (default true = include)
|
|
35305
|
+
* @type {boolean}
|
|
35306
|
+
* @memberof QuerySuggestionsServiceQuerySuggestionsRequest
|
|
35307
|
+
*/
|
|
35308
|
+
'include_dropdown_product_list'?: boolean;
|
|
35230
35309
|
/**
|
|
35231
35310
|
* Rich dropdown recommendations (optional, data-agnostic)
|
|
35232
35311
|
* @type {boolean}
|
|
@@ -35245,6 +35324,12 @@ export interface QuerySuggestionsServiceQuerySuggestionsRequest {
|
|
|
35245
35324
|
* @memberof QuerySuggestionsServiceQuerySuggestionsRequest
|
|
35246
35325
|
*/
|
|
35247
35326
|
'include_facets'?: boolean;
|
|
35327
|
+
/**
|
|
35328
|
+
* When false, omit filtered_tabs from dropdown extensions (default true)
|
|
35329
|
+
* @type {boolean}
|
|
35330
|
+
* @memberof QuerySuggestionsServiceQuerySuggestionsRequest
|
|
35331
|
+
*/
|
|
35332
|
+
'include_filtered_tabs'?: boolean;
|
|
35248
35333
|
/**
|
|
35249
35334
|
* Max categories per suggestion (default: 3)
|
|
35250
35335
|
* @type {number}
|
|
@@ -55287,38 +55372,47 @@ export declare const QuerySuggestionsApiAxiosParamCreator: (configuration?: Conf
|
|
|
55287
55372
|
*/
|
|
55288
55373
|
v1SuggestionsConfigGet: (xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
55289
55374
|
/**
|
|
55290
|
-
* Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering,
|
|
55375
|
+
* 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.
|
|
55291
55376
|
* @summary Get Query Suggestions
|
|
55292
55377
|
* @param {string} xStoreid Store ID
|
|
55293
55378
|
* @param {string} xStoresecret Store Secret
|
|
55294
55379
|
* @param {string} [xUserId] User ID for personalization (logged-in user)
|
|
55295
55380
|
* @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
|
|
55296
55381
|
* @param {string} [xSessionId] Session ID for personalization
|
|
55297
|
-
* @param {string} [query] Partial query to get suggestions for
|
|
55382
|
+
* @param {string} [query] Partial query to get suggestions for (supports both \'query\' and \'q\')
|
|
55383
|
+
* @param {string} [q] Alias for \'query\' parameter
|
|
55298
55384
|
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
55299
55385
|
* @param {number} [page] Page number for pagination
|
|
55300
55386
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
|
|
55301
55387
|
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
|
|
55302
55388
|
* @param {boolean} [includeCategories] Include category information in suggestions
|
|
55303
55389
|
* @param {boolean} [includeFacets] Include popular facets/filters information
|
|
55390
|
+
* @param {boolean} [includeDropdownRecommendations] Include rich dropdown recommendations (trending products, filtered tabs)
|
|
55391
|
+
* @param {boolean} [includeDropdownProductList] Include product list in dropdown recommendations
|
|
55392
|
+
* @param {boolean} [includeFilteredTabs] Include filtered tabs in dropdown recommendations
|
|
55393
|
+
* @param {boolean} [includeEmptyQueryRecommendations] Return popular suggestions when query is empty
|
|
55304
55394
|
* @param {number} [maxCategories] Maximum categories per suggestion
|
|
55305
55395
|
* @param {number} [maxFacets] Maximum facets per suggestion
|
|
55306
55396
|
* @param {number} [minPopularity] Minimum popularity threshold
|
|
55307
55397
|
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
|
|
55308
55398
|
* @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
|
|
55399
|
+
* @param {string} [filteredTabs] URL-encoded JSON array of filtered tab configurations (e.g., [{\\
|
|
55400
|
+
* @param {string} [userId] User ID for personalization (query param fallback, header takes precedence)
|
|
55401
|
+
* @param {string} [anonId] Anonymous ID for personalization (query param fallback, header takes precedence)
|
|
55402
|
+
* @param {string} [sessionId] Session ID for personalization (query param fallback, header takes precedence)
|
|
55309
55403
|
* @param {*} [options] Override http request option.
|
|
55310
55404
|
* @throws {RequiredError}
|
|
55311
55405
|
*/
|
|
55312
|
-
v1SuggestionsQueriesGet: (xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, query?: string, hitsPerPage?: number, page?: number, analyticsTags?: string, tagsMatchMode?: V1SuggestionsQueriesGetTagsMatchModeEnum, includeCategories?: boolean, includeFacets?: boolean, maxCategories?: number, maxFacets?: number, minPopularity?: number, timeRange?: V1SuggestionsQueriesGetTimeRangeEnum, disableTypoTolerance?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
55406
|
+
v1SuggestionsQueriesGet: (xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, query?: string, q?: string, hitsPerPage?: number, page?: number, analyticsTags?: string, tagsMatchMode?: V1SuggestionsQueriesGetTagsMatchModeEnum, includeCategories?: boolean, includeFacets?: boolean, includeDropdownRecommendations?: boolean, includeDropdownProductList?: boolean, includeFilteredTabs?: boolean, includeEmptyQueryRecommendations?: boolean, maxCategories?: number, maxFacets?: number, minPopularity?: number, timeRange?: V1SuggestionsQueriesGetTimeRangeEnum, disableTypoTolerance?: boolean, filteredTabs?: string, userId?: string, anonId?: string, sessionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
55313
55407
|
/**
|
|
55314
|
-
* Same as GET
|
|
55408
|
+
* 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.
|
|
55315
55409
|
* @summary Post Query Suggestions
|
|
55316
55410
|
* @param {string} xStoreid Store ID
|
|
55317
55411
|
* @param {string} xStoresecret Store Secret
|
|
55318
55412
|
* @param {string} [xUserId] User ID for personalization (logged-in user)
|
|
55319
55413
|
* @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
|
|
55320
55414
|
* @param {string} [xSessionId] Session ID for personalization
|
|
55321
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, filtered_tabs, etc.)
|
|
55415
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, include_dropdown_recommendations, filtered_tabs, etc.)
|
|
55322
55416
|
* @param {*} [options] Override http request option.
|
|
55323
55417
|
* @throws {RequiredError}
|
|
55324
55418
|
*/
|
|
@@ -55339,38 +55433,47 @@ export declare const QuerySuggestionsApiFp: (configuration?: Configuration) => {
|
|
|
55339
55433
|
*/
|
|
55340
55434
|
v1SuggestionsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1SuggestionsConfigGet200Response>>;
|
|
55341
55435
|
/**
|
|
55342
|
-
* Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering,
|
|
55436
|
+
* 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.
|
|
55343
55437
|
* @summary Get Query Suggestions
|
|
55344
55438
|
* @param {string} xStoreid Store ID
|
|
55345
55439
|
* @param {string} xStoresecret Store Secret
|
|
55346
55440
|
* @param {string} [xUserId] User ID for personalization (logged-in user)
|
|
55347
55441
|
* @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
|
|
55348
55442
|
* @param {string} [xSessionId] Session ID for personalization
|
|
55349
|
-
* @param {string} [query] Partial query to get suggestions for
|
|
55443
|
+
* @param {string} [query] Partial query to get suggestions for (supports both \'query\' and \'q\')
|
|
55444
|
+
* @param {string} [q] Alias for \'query\' parameter
|
|
55350
55445
|
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
55351
55446
|
* @param {number} [page] Page number for pagination
|
|
55352
55447
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
|
|
55353
55448
|
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
|
|
55354
55449
|
* @param {boolean} [includeCategories] Include category information in suggestions
|
|
55355
55450
|
* @param {boolean} [includeFacets] Include popular facets/filters information
|
|
55451
|
+
* @param {boolean} [includeDropdownRecommendations] Include rich dropdown recommendations (trending products, filtered tabs)
|
|
55452
|
+
* @param {boolean} [includeDropdownProductList] Include product list in dropdown recommendations
|
|
55453
|
+
* @param {boolean} [includeFilteredTabs] Include filtered tabs in dropdown recommendations
|
|
55454
|
+
* @param {boolean} [includeEmptyQueryRecommendations] Return popular suggestions when query is empty
|
|
55356
55455
|
* @param {number} [maxCategories] Maximum categories per suggestion
|
|
55357
55456
|
* @param {number} [maxFacets] Maximum facets per suggestion
|
|
55358
55457
|
* @param {number} [minPopularity] Minimum popularity threshold
|
|
55359
55458
|
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
|
|
55360
55459
|
* @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
|
|
55460
|
+
* @param {string} [filteredTabs] URL-encoded JSON array of filtered tab configurations (e.g., [{\\
|
|
55461
|
+
* @param {string} [userId] User ID for personalization (query param fallback, header takes precedence)
|
|
55462
|
+
* @param {string} [anonId] Anonymous ID for personalization (query param fallback, header takes precedence)
|
|
55463
|
+
* @param {string} [sessionId] Session ID for personalization (query param fallback, header takes precedence)
|
|
55361
55464
|
* @param {*} [options] Override http request option.
|
|
55362
55465
|
* @throws {RequiredError}
|
|
55363
55466
|
*/
|
|
55364
|
-
v1SuggestionsQueriesGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, query?: string, hitsPerPage?: number, page?: number, analyticsTags?: string, tagsMatchMode?: V1SuggestionsQueriesGetTagsMatchModeEnum, includeCategories?: boolean, includeFacets?: boolean, maxCategories?: number, maxFacets?: number, minPopularity?: number, timeRange?: V1SuggestionsQueriesGetTimeRangeEnum, disableTypoTolerance?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>>;
|
|
55467
|
+
v1SuggestionsQueriesGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, query?: string, q?: string, hitsPerPage?: number, page?: number, analyticsTags?: string, tagsMatchMode?: V1SuggestionsQueriesGetTagsMatchModeEnum, includeCategories?: boolean, includeFacets?: boolean, includeDropdownRecommendations?: boolean, includeDropdownProductList?: boolean, includeFilteredTabs?: boolean, includeEmptyQueryRecommendations?: boolean, maxCategories?: number, maxFacets?: number, minPopularity?: number, timeRange?: V1SuggestionsQueriesGetTimeRangeEnum, disableTypoTolerance?: boolean, filteredTabs?: string, userId?: string, anonId?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>>;
|
|
55365
55468
|
/**
|
|
55366
|
-
* Same as GET
|
|
55469
|
+
* 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.
|
|
55367
55470
|
* @summary Post Query Suggestions
|
|
55368
55471
|
* @param {string} xStoreid Store ID
|
|
55369
55472
|
* @param {string} xStoresecret Store Secret
|
|
55370
55473
|
* @param {string} [xUserId] User ID for personalization (logged-in user)
|
|
55371
55474
|
* @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
|
|
55372
55475
|
* @param {string} [xSessionId] Session ID for personalization
|
|
55373
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, filtered_tabs, etc.)
|
|
55476
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, include_dropdown_recommendations, filtered_tabs, etc.)
|
|
55374
55477
|
* @param {*} [options] Override http request option.
|
|
55375
55478
|
* @throws {RequiredError}
|
|
55376
55479
|
*/
|
|
@@ -55391,38 +55494,47 @@ export declare const QuerySuggestionsApiFactory: (configuration?: Configuration,
|
|
|
55391
55494
|
*/
|
|
55392
55495
|
v1SuggestionsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): AxiosPromise<V1SuggestionsConfigGet200Response>;
|
|
55393
55496
|
/**
|
|
55394
|
-
* Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering,
|
|
55497
|
+
* 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.
|
|
55395
55498
|
* @summary Get Query Suggestions
|
|
55396
55499
|
* @param {string} xStoreid Store ID
|
|
55397
55500
|
* @param {string} xStoresecret Store Secret
|
|
55398
55501
|
* @param {string} [xUserId] User ID for personalization (logged-in user)
|
|
55399
55502
|
* @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
|
|
55400
55503
|
* @param {string} [xSessionId] Session ID for personalization
|
|
55401
|
-
* @param {string} [query] Partial query to get suggestions for
|
|
55504
|
+
* @param {string} [query] Partial query to get suggestions for (supports both \'query\' and \'q\')
|
|
55505
|
+
* @param {string} [q] Alias for \'query\' parameter
|
|
55402
55506
|
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
55403
55507
|
* @param {number} [page] Page number for pagination
|
|
55404
55508
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
|
|
55405
55509
|
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
|
|
55406
55510
|
* @param {boolean} [includeCategories] Include category information in suggestions
|
|
55407
55511
|
* @param {boolean} [includeFacets] Include popular facets/filters information
|
|
55512
|
+
* @param {boolean} [includeDropdownRecommendations] Include rich dropdown recommendations (trending products, filtered tabs)
|
|
55513
|
+
* @param {boolean} [includeDropdownProductList] Include product list in dropdown recommendations
|
|
55514
|
+
* @param {boolean} [includeFilteredTabs] Include filtered tabs in dropdown recommendations
|
|
55515
|
+
* @param {boolean} [includeEmptyQueryRecommendations] Return popular suggestions when query is empty
|
|
55408
55516
|
* @param {number} [maxCategories] Maximum categories per suggestion
|
|
55409
55517
|
* @param {number} [maxFacets] Maximum facets per suggestion
|
|
55410
55518
|
* @param {number} [minPopularity] Minimum popularity threshold
|
|
55411
55519
|
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
|
|
55412
55520
|
* @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
|
|
55521
|
+
* @param {string} [filteredTabs] URL-encoded JSON array of filtered tab configurations (e.g., [{\\
|
|
55522
|
+
* @param {string} [userId] User ID for personalization (query param fallback, header takes precedence)
|
|
55523
|
+
* @param {string} [anonId] Anonymous ID for personalization (query param fallback, header takes precedence)
|
|
55524
|
+
* @param {string} [sessionId] Session ID for personalization (query param fallback, header takes precedence)
|
|
55413
55525
|
* @param {*} [options] Override http request option.
|
|
55414
55526
|
* @throws {RequiredError}
|
|
55415
55527
|
*/
|
|
55416
|
-
v1SuggestionsQueriesGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, query?: string, hitsPerPage?: number, page?: number, analyticsTags?: string, tagsMatchMode?: V1SuggestionsQueriesGetTagsMatchModeEnum, includeCategories?: boolean, includeFacets?: boolean, maxCategories?: number, maxFacets?: number, minPopularity?: number, timeRange?: V1SuggestionsQueriesGetTimeRangeEnum, disableTypoTolerance?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>;
|
|
55528
|
+
v1SuggestionsQueriesGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, query?: string, q?: string, hitsPerPage?: number, page?: number, analyticsTags?: string, tagsMatchMode?: V1SuggestionsQueriesGetTagsMatchModeEnum, includeCategories?: boolean, includeFacets?: boolean, includeDropdownRecommendations?: boolean, includeDropdownProductList?: boolean, includeFilteredTabs?: boolean, includeEmptyQueryRecommendations?: boolean, maxCategories?: number, maxFacets?: number, minPopularity?: number, timeRange?: V1SuggestionsQueriesGetTimeRangeEnum, disableTypoTolerance?: boolean, filteredTabs?: string, userId?: string, anonId?: string, sessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>;
|
|
55417
55529
|
/**
|
|
55418
|
-
* Same as GET
|
|
55530
|
+
* 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.
|
|
55419
55531
|
* @summary Post Query Suggestions
|
|
55420
55532
|
* @param {string} xStoreid Store ID
|
|
55421
55533
|
* @param {string} xStoresecret Store Secret
|
|
55422
55534
|
* @param {string} [xUserId] User ID for personalization (logged-in user)
|
|
55423
55535
|
* @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
|
|
55424
55536
|
* @param {string} [xSessionId] Session ID for personalization
|
|
55425
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, filtered_tabs, etc.)
|
|
55537
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, include_dropdown_recommendations, filtered_tabs, etc.)
|
|
55426
55538
|
* @param {*} [options] Override http request option.
|
|
55427
55539
|
* @throws {RequiredError}
|
|
55428
55540
|
*/
|
|
@@ -55446,39 +55558,48 @@ export declare class QuerySuggestionsApi extends BaseAPI {
|
|
|
55446
55558
|
*/
|
|
55447
55559
|
v1SuggestionsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V1SuggestionsConfigGet200Response, any, {}>>;
|
|
55448
55560
|
/**
|
|
55449
|
-
* Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering,
|
|
55561
|
+
* 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.
|
|
55450
55562
|
* @summary Get Query Suggestions
|
|
55451
55563
|
* @param {string} xStoreid Store ID
|
|
55452
55564
|
* @param {string} xStoresecret Store Secret
|
|
55453
55565
|
* @param {string} [xUserId] User ID for personalization (logged-in user)
|
|
55454
55566
|
* @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
|
|
55455
55567
|
* @param {string} [xSessionId] Session ID for personalization
|
|
55456
|
-
* @param {string} [query] Partial query to get suggestions for
|
|
55568
|
+
* @param {string} [query] Partial query to get suggestions for (supports both \'query\' and \'q\')
|
|
55569
|
+
* @param {string} [q] Alias for \'query\' parameter
|
|
55457
55570
|
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
55458
55571
|
* @param {number} [page] Page number for pagination
|
|
55459
55572
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
|
|
55460
55573
|
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
|
|
55461
55574
|
* @param {boolean} [includeCategories] Include category information in suggestions
|
|
55462
55575
|
* @param {boolean} [includeFacets] Include popular facets/filters information
|
|
55576
|
+
* @param {boolean} [includeDropdownRecommendations] Include rich dropdown recommendations (trending products, filtered tabs)
|
|
55577
|
+
* @param {boolean} [includeDropdownProductList] Include product list in dropdown recommendations
|
|
55578
|
+
* @param {boolean} [includeFilteredTabs] Include filtered tabs in dropdown recommendations
|
|
55579
|
+
* @param {boolean} [includeEmptyQueryRecommendations] Return popular suggestions when query is empty
|
|
55463
55580
|
* @param {number} [maxCategories] Maximum categories per suggestion
|
|
55464
55581
|
* @param {number} [maxFacets] Maximum facets per suggestion
|
|
55465
55582
|
* @param {number} [minPopularity] Minimum popularity threshold
|
|
55466
55583
|
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
|
|
55467
55584
|
* @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
|
|
55585
|
+
* @param {string} [filteredTabs] URL-encoded JSON array of filtered tab configurations (e.g., [{\\
|
|
55586
|
+
* @param {string} [userId] User ID for personalization (query param fallback, header takes precedence)
|
|
55587
|
+
* @param {string} [anonId] Anonymous ID for personalization (query param fallback, header takes precedence)
|
|
55588
|
+
* @param {string} [sessionId] Session ID for personalization (query param fallback, header takes precedence)
|
|
55468
55589
|
* @param {*} [options] Override http request option.
|
|
55469
55590
|
* @throws {RequiredError}
|
|
55470
55591
|
* @memberof QuerySuggestionsApi
|
|
55471
55592
|
*/
|
|
55472
|
-
v1SuggestionsQueriesGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, query?: string, hitsPerPage?: number, page?: number, analyticsTags?: string, tagsMatchMode?: V1SuggestionsQueriesGetTagsMatchModeEnum, includeCategories?: boolean, includeFacets?: boolean, maxCategories?: number, maxFacets?: number, minPopularity?: number, timeRange?: V1SuggestionsQueriesGetTimeRangeEnum, disableTypoTolerance?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuerySuggestionsServiceQuerySuggestionsAPIResponse, any, {}>>;
|
|
55593
|
+
v1SuggestionsQueriesGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, query?: string, q?: string, hitsPerPage?: number, page?: number, analyticsTags?: string, tagsMatchMode?: V1SuggestionsQueriesGetTagsMatchModeEnum, includeCategories?: boolean, includeFacets?: boolean, includeDropdownRecommendations?: boolean, includeDropdownProductList?: boolean, includeFilteredTabs?: boolean, includeEmptyQueryRecommendations?: boolean, maxCategories?: number, maxFacets?: number, minPopularity?: number, timeRange?: V1SuggestionsQueriesGetTimeRangeEnum, disableTypoTolerance?: boolean, filteredTabs?: string, userId?: string, anonId?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuerySuggestionsServiceQuerySuggestionsAPIResponse, any, {}>>;
|
|
55473
55594
|
/**
|
|
55474
|
-
* Same as GET
|
|
55595
|
+
* 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.
|
|
55475
55596
|
* @summary Post Query Suggestions
|
|
55476
55597
|
* @param {string} xStoreid Store ID
|
|
55477
55598
|
* @param {string} xStoresecret Store Secret
|
|
55478
55599
|
* @param {string} [xUserId] User ID for personalization (logged-in user)
|
|
55479
55600
|
* @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
|
|
55480
55601
|
* @param {string} [xSessionId] Session ID for personalization
|
|
55481
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, filtered_tabs, etc.)
|
|
55602
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, include_dropdown_recommendations, filtered_tabs, etc.)
|
|
55482
55603
|
* @param {*} [options] Override http request option.
|
|
55483
55604
|
* @throws {RequiredError}
|
|
55484
55605
|
* @memberof QuerySuggestionsApi
|
|
@@ -58777,6 +58898,56 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
58777
58898
|
* @throws {RequiredError}
|
|
58778
58899
|
*/
|
|
58779
58900
|
v1IndexIndexnameDefaultsGet: (indexname: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
58901
|
+
/**
|
|
58902
|
+
* Search documents using query parameters. Supports all features of POST endpoint.
|
|
58903
|
+
* @summary Public Search API (GET)
|
|
58904
|
+
* @param {string} xStoreid Store ID
|
|
58905
|
+
* @param {string} xStoresecret Store Secret
|
|
58906
|
+
* @param {string} q Search query
|
|
58907
|
+
* @param {string} [xUserId] User ID for personalization
|
|
58908
|
+
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
58909
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
58910
|
+
* @param {number} [page] Page number (default: 1)
|
|
58911
|
+
* @param {number} [perPage] Items per page (default: 10)
|
|
58912
|
+
* @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
|
|
58913
|
+
* @param {string} [filterBy] Filter string (e.g., category:shirts)
|
|
58914
|
+
* @param {string} [facetBy] Facet fields (comma-separated)
|
|
58915
|
+
* @param {number} [maxFacetValues] Maximum facet values to return
|
|
58916
|
+
* @param {boolean} [widgetMode] Return widget-formatted results
|
|
58917
|
+
* @param {boolean} [includeSuggestions] Include autocomplete suggestions
|
|
58918
|
+
* @param {number} [suggestionsLimit] Number of suggestions to return
|
|
58919
|
+
* @param {string} [analyticsTags] Analytics tags (comma-separated)
|
|
58920
|
+
* @param {string} [stopwordSets] Stopword set IDs (comma-separated)
|
|
58921
|
+
* @param {string} [synonymSets] Synonym set IDs (comma-separated)
|
|
58922
|
+
* @param {string} [searchFields] Fields to search in (comma-separated)
|
|
58923
|
+
* @param {string} [returnFields] Fields to return (comma-separated)
|
|
58924
|
+
* @param {string} [omitFields] Fields to omit (comma-separated)
|
|
58925
|
+
* @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
|
|
58926
|
+
* @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
|
|
58927
|
+
* @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
|
|
58928
|
+
* @param {string} [groupField] Field to group results by
|
|
58929
|
+
* @param {number} [groupSize] Number of results per group
|
|
58930
|
+
* @param {string} [snippetPrefix] Prefix for highlighted snippets
|
|
58931
|
+
* @param {string} [snippetSuffix] Suffix for highlighted snippets
|
|
58932
|
+
* @param {number} [snippetTokenLimit] Maximum tokens in snippet
|
|
58933
|
+
* @param {number} [snippetMinLen] Minimum snippet length
|
|
58934
|
+
* @param {boolean} [includeSnippets] Include snippets in results
|
|
58935
|
+
* @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
|
|
58936
|
+
* @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
|
|
58937
|
+
* @param {number} [typoMax] Maximum typo tolerance
|
|
58938
|
+
* @param {number} [typoMinLen1] Min word length for 1 typo
|
|
58939
|
+
* @param {number} [typoMinLen2] Min word length for 2 typos
|
|
58940
|
+
* @param {number} [searchTimeoutMs] Search timeout in milliseconds
|
|
58941
|
+
* @param {boolean} [requireAllTerms] Require all search terms to match
|
|
58942
|
+
* @param {boolean} [exactMatchBoost] Boost exact matches
|
|
58943
|
+
* @param {boolean} [cacheResults] Cache search results
|
|
58944
|
+
* @param {boolean} [applyRules] Apply search rules
|
|
58945
|
+
* @param {string} [presetName] Search preset name to use
|
|
58946
|
+
* @param {string} [facetSearchText] Text to filter facet values
|
|
58947
|
+
* @param {*} [options] Override http request option.
|
|
58948
|
+
* @throws {RequiredError}
|
|
58949
|
+
*/
|
|
58950
|
+
v1SearchGet: (xStoreid: string, xStoresecret: string, q: string, xUserId?: string, xAnonId?: string, xSessionId?: string, page?: number, perPage?: number, sortBy?: string, filterBy?: string, facetBy?: string, maxFacetValues?: number, widgetMode?: boolean, includeSuggestions?: boolean, suggestionsLimit?: number, analyticsTags?: string, stopwordSets?: string, synonymSets?: string, searchFields?: string, returnFields?: string, omitFields?: string, snippetFields?: string, fullSnippetFields?: string, fieldWeights?: string, groupField?: string, groupSize?: number, snippetPrefix?: string, snippetSuffix?: string, snippetTokenLimit?: number, snippetMinLen?: number, includeSnippets?: boolean, prefixMode?: string, infixMode?: string, typoMax?: number, typoMinLen1?: number, typoMinLen2?: number, searchTimeoutMs?: number, requireAllTerms?: boolean, exactMatchBoost?: boolean, cacheResults?: boolean, applyRules?: boolean, presetName?: string, facetSearchText?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
58780
58951
|
/**
|
|
58781
58952
|
* 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.
|
|
58782
58953
|
* @summary Public Search API
|
|
@@ -58848,6 +59019,56 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
|
58848
59019
|
* @throws {RequiredError}
|
|
58849
59020
|
*/
|
|
58850
59021
|
v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>>;
|
|
59022
|
+
/**
|
|
59023
|
+
* Search documents using query parameters. Supports all features of POST endpoint.
|
|
59024
|
+
* @summary Public Search API (GET)
|
|
59025
|
+
* @param {string} xStoreid Store ID
|
|
59026
|
+
* @param {string} xStoresecret Store Secret
|
|
59027
|
+
* @param {string} q Search query
|
|
59028
|
+
* @param {string} [xUserId] User ID for personalization
|
|
59029
|
+
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
59030
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
59031
|
+
* @param {number} [page] Page number (default: 1)
|
|
59032
|
+
* @param {number} [perPage] Items per page (default: 10)
|
|
59033
|
+
* @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
|
|
59034
|
+
* @param {string} [filterBy] Filter string (e.g., category:shirts)
|
|
59035
|
+
* @param {string} [facetBy] Facet fields (comma-separated)
|
|
59036
|
+
* @param {number} [maxFacetValues] Maximum facet values to return
|
|
59037
|
+
* @param {boolean} [widgetMode] Return widget-formatted results
|
|
59038
|
+
* @param {boolean} [includeSuggestions] Include autocomplete suggestions
|
|
59039
|
+
* @param {number} [suggestionsLimit] Number of suggestions to return
|
|
59040
|
+
* @param {string} [analyticsTags] Analytics tags (comma-separated)
|
|
59041
|
+
* @param {string} [stopwordSets] Stopword set IDs (comma-separated)
|
|
59042
|
+
* @param {string} [synonymSets] Synonym set IDs (comma-separated)
|
|
59043
|
+
* @param {string} [searchFields] Fields to search in (comma-separated)
|
|
59044
|
+
* @param {string} [returnFields] Fields to return (comma-separated)
|
|
59045
|
+
* @param {string} [omitFields] Fields to omit (comma-separated)
|
|
59046
|
+
* @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
|
|
59047
|
+
* @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
|
|
59048
|
+
* @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
|
|
59049
|
+
* @param {string} [groupField] Field to group results by
|
|
59050
|
+
* @param {number} [groupSize] Number of results per group
|
|
59051
|
+
* @param {string} [snippetPrefix] Prefix for highlighted snippets
|
|
59052
|
+
* @param {string} [snippetSuffix] Suffix for highlighted snippets
|
|
59053
|
+
* @param {number} [snippetTokenLimit] Maximum tokens in snippet
|
|
59054
|
+
* @param {number} [snippetMinLen] Minimum snippet length
|
|
59055
|
+
* @param {boolean} [includeSnippets] Include snippets in results
|
|
59056
|
+
* @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
|
|
59057
|
+
* @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
|
|
59058
|
+
* @param {number} [typoMax] Maximum typo tolerance
|
|
59059
|
+
* @param {number} [typoMinLen1] Min word length for 1 typo
|
|
59060
|
+
* @param {number} [typoMinLen2] Min word length for 2 typos
|
|
59061
|
+
* @param {number} [searchTimeoutMs] Search timeout in milliseconds
|
|
59062
|
+
* @param {boolean} [requireAllTerms] Require all search terms to match
|
|
59063
|
+
* @param {boolean} [exactMatchBoost] Boost exact matches
|
|
59064
|
+
* @param {boolean} [cacheResults] Cache search results
|
|
59065
|
+
* @param {boolean} [applyRules] Apply search rules
|
|
59066
|
+
* @param {string} [presetName] Search preset name to use
|
|
59067
|
+
* @param {string} [facetSearchText] Text to filter facet values
|
|
59068
|
+
* @param {*} [options] Override http request option.
|
|
59069
|
+
* @throws {RequiredError}
|
|
59070
|
+
*/
|
|
59071
|
+
v1SearchGet(xStoreid: string, xStoresecret: string, q: string, xUserId?: string, xAnonId?: string, xSessionId?: string, page?: number, perPage?: number, sortBy?: string, filterBy?: string, facetBy?: string, maxFacetValues?: number, widgetMode?: boolean, includeSuggestions?: boolean, suggestionsLimit?: number, analyticsTags?: string, stopwordSets?: string, synonymSets?: string, searchFields?: string, returnFields?: string, omitFields?: string, snippetFields?: string, fullSnippetFields?: string, fieldWeights?: string, groupField?: string, groupSize?: number, snippetPrefix?: string, snippetSuffix?: string, snippetTokenLimit?: number, snippetMinLen?: number, includeSnippets?: boolean, prefixMode?: string, infixMode?: string, typoMax?: number, typoMinLen1?: number, typoMinLen2?: number, searchTimeoutMs?: number, requireAllTerms?: boolean, exactMatchBoost?: boolean, cacheResults?: boolean, applyRules?: boolean, presetName?: string, facetSearchText?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOfficialSearchResponseWrapper>>;
|
|
58851
59072
|
/**
|
|
58852
59073
|
* 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.
|
|
58853
59074
|
* @summary Public Search API
|
|
@@ -58919,6 +59140,56 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
|
|
|
58919
59140
|
* @throws {RequiredError}
|
|
58920
59141
|
*/
|
|
58921
59142
|
v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>;
|
|
59143
|
+
/**
|
|
59144
|
+
* Search documents using query parameters. Supports all features of POST endpoint.
|
|
59145
|
+
* @summary Public Search API (GET)
|
|
59146
|
+
* @param {string} xStoreid Store ID
|
|
59147
|
+
* @param {string} xStoresecret Store Secret
|
|
59148
|
+
* @param {string} q Search query
|
|
59149
|
+
* @param {string} [xUserId] User ID for personalization
|
|
59150
|
+
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
59151
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
59152
|
+
* @param {number} [page] Page number (default: 1)
|
|
59153
|
+
* @param {number} [perPage] Items per page (default: 10)
|
|
59154
|
+
* @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
|
|
59155
|
+
* @param {string} [filterBy] Filter string (e.g., category:shirts)
|
|
59156
|
+
* @param {string} [facetBy] Facet fields (comma-separated)
|
|
59157
|
+
* @param {number} [maxFacetValues] Maximum facet values to return
|
|
59158
|
+
* @param {boolean} [widgetMode] Return widget-formatted results
|
|
59159
|
+
* @param {boolean} [includeSuggestions] Include autocomplete suggestions
|
|
59160
|
+
* @param {number} [suggestionsLimit] Number of suggestions to return
|
|
59161
|
+
* @param {string} [analyticsTags] Analytics tags (comma-separated)
|
|
59162
|
+
* @param {string} [stopwordSets] Stopword set IDs (comma-separated)
|
|
59163
|
+
* @param {string} [synonymSets] Synonym set IDs (comma-separated)
|
|
59164
|
+
* @param {string} [searchFields] Fields to search in (comma-separated)
|
|
59165
|
+
* @param {string} [returnFields] Fields to return (comma-separated)
|
|
59166
|
+
* @param {string} [omitFields] Fields to omit (comma-separated)
|
|
59167
|
+
* @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
|
|
59168
|
+
* @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
|
|
59169
|
+
* @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
|
|
59170
|
+
* @param {string} [groupField] Field to group results by
|
|
59171
|
+
* @param {number} [groupSize] Number of results per group
|
|
59172
|
+
* @param {string} [snippetPrefix] Prefix for highlighted snippets
|
|
59173
|
+
* @param {string} [snippetSuffix] Suffix for highlighted snippets
|
|
59174
|
+
* @param {number} [snippetTokenLimit] Maximum tokens in snippet
|
|
59175
|
+
* @param {number} [snippetMinLen] Minimum snippet length
|
|
59176
|
+
* @param {boolean} [includeSnippets] Include snippets in results
|
|
59177
|
+
* @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
|
|
59178
|
+
* @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
|
|
59179
|
+
* @param {number} [typoMax] Maximum typo tolerance
|
|
59180
|
+
* @param {number} [typoMinLen1] Min word length for 1 typo
|
|
59181
|
+
* @param {number} [typoMinLen2] Min word length for 2 typos
|
|
59182
|
+
* @param {number} [searchTimeoutMs] Search timeout in milliseconds
|
|
59183
|
+
* @param {boolean} [requireAllTerms] Require all search terms to match
|
|
59184
|
+
* @param {boolean} [exactMatchBoost] Boost exact matches
|
|
59185
|
+
* @param {boolean} [cacheResults] Cache search results
|
|
59186
|
+
* @param {boolean} [applyRules] Apply search rules
|
|
59187
|
+
* @param {string} [presetName] Search preset name to use
|
|
59188
|
+
* @param {string} [facetSearchText] Text to filter facet values
|
|
59189
|
+
* @param {*} [options] Override http request option.
|
|
59190
|
+
* @throws {RequiredError}
|
|
59191
|
+
*/
|
|
59192
|
+
v1SearchGet(xStoreid: string, xStoresecret: string, q: string, xUserId?: string, xAnonId?: string, xSessionId?: string, page?: number, perPage?: number, sortBy?: string, filterBy?: string, facetBy?: string, maxFacetValues?: number, widgetMode?: boolean, includeSuggestions?: boolean, suggestionsLimit?: number, analyticsTags?: string, stopwordSets?: string, synonymSets?: string, searchFields?: string, returnFields?: string, omitFields?: string, snippetFields?: string, fullSnippetFields?: string, fieldWeights?: string, groupField?: string, groupSize?: number, snippetPrefix?: string, snippetSuffix?: string, snippetTokenLimit?: number, snippetMinLen?: number, includeSnippets?: boolean, prefixMode?: string, infixMode?: string, typoMax?: number, typoMinLen1?: number, typoMinLen2?: number, searchTimeoutMs?: number, requireAllTerms?: boolean, exactMatchBoost?: boolean, cacheResults?: boolean, applyRules?: boolean, presetName?: string, facetSearchText?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOfficialSearchResponseWrapper>;
|
|
58922
59193
|
/**
|
|
58923
59194
|
* 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.
|
|
58924
59195
|
* @summary Public Search API
|
|
@@ -58998,6 +59269,57 @@ export declare class SearchApi extends BaseAPI {
|
|
|
58998
59269
|
* @memberof SearchApi
|
|
58999
59270
|
*/
|
|
59000
59271
|
v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaBasedDefaultsResponseWrapper, any, {}>>;
|
|
59272
|
+
/**
|
|
59273
|
+
* Search documents using query parameters. Supports all features of POST endpoint.
|
|
59274
|
+
* @summary Public Search API (GET)
|
|
59275
|
+
* @param {string} xStoreid Store ID
|
|
59276
|
+
* @param {string} xStoresecret Store Secret
|
|
59277
|
+
* @param {string} q Search query
|
|
59278
|
+
* @param {string} [xUserId] User ID for personalization
|
|
59279
|
+
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
59280
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
59281
|
+
* @param {number} [page] Page number (default: 1)
|
|
59282
|
+
* @param {number} [perPage] Items per page (default: 10)
|
|
59283
|
+
* @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
|
|
59284
|
+
* @param {string} [filterBy] Filter string (e.g., category:shirts)
|
|
59285
|
+
* @param {string} [facetBy] Facet fields (comma-separated)
|
|
59286
|
+
* @param {number} [maxFacetValues] Maximum facet values to return
|
|
59287
|
+
* @param {boolean} [widgetMode] Return widget-formatted results
|
|
59288
|
+
* @param {boolean} [includeSuggestions] Include autocomplete suggestions
|
|
59289
|
+
* @param {number} [suggestionsLimit] Number of suggestions to return
|
|
59290
|
+
* @param {string} [analyticsTags] Analytics tags (comma-separated)
|
|
59291
|
+
* @param {string} [stopwordSets] Stopword set IDs (comma-separated)
|
|
59292
|
+
* @param {string} [synonymSets] Synonym set IDs (comma-separated)
|
|
59293
|
+
* @param {string} [searchFields] Fields to search in (comma-separated)
|
|
59294
|
+
* @param {string} [returnFields] Fields to return (comma-separated)
|
|
59295
|
+
* @param {string} [omitFields] Fields to omit (comma-separated)
|
|
59296
|
+
* @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
|
|
59297
|
+
* @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
|
|
59298
|
+
* @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
|
|
59299
|
+
* @param {string} [groupField] Field to group results by
|
|
59300
|
+
* @param {number} [groupSize] Number of results per group
|
|
59301
|
+
* @param {string} [snippetPrefix] Prefix for highlighted snippets
|
|
59302
|
+
* @param {string} [snippetSuffix] Suffix for highlighted snippets
|
|
59303
|
+
* @param {number} [snippetTokenLimit] Maximum tokens in snippet
|
|
59304
|
+
* @param {number} [snippetMinLen] Minimum snippet length
|
|
59305
|
+
* @param {boolean} [includeSnippets] Include snippets in results
|
|
59306
|
+
* @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
|
|
59307
|
+
* @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
|
|
59308
|
+
* @param {number} [typoMax] Maximum typo tolerance
|
|
59309
|
+
* @param {number} [typoMinLen1] Min word length for 1 typo
|
|
59310
|
+
* @param {number} [typoMinLen2] Min word length for 2 typos
|
|
59311
|
+
* @param {number} [searchTimeoutMs] Search timeout in milliseconds
|
|
59312
|
+
* @param {boolean} [requireAllTerms] Require all search terms to match
|
|
59313
|
+
* @param {boolean} [exactMatchBoost] Boost exact matches
|
|
59314
|
+
* @param {boolean} [cacheResults] Cache search results
|
|
59315
|
+
* @param {boolean} [applyRules] Apply search rules
|
|
59316
|
+
* @param {string} [presetName] Search preset name to use
|
|
59317
|
+
* @param {string} [facetSearchText] Text to filter facet values
|
|
59318
|
+
* @param {*} [options] Override http request option.
|
|
59319
|
+
* @throws {RequiredError}
|
|
59320
|
+
* @memberof SearchApi
|
|
59321
|
+
*/
|
|
59322
|
+
v1SearchGet(xStoreid: string, xStoresecret: string, q: string, xUserId?: string, xAnonId?: string, xSessionId?: string, page?: number, perPage?: number, sortBy?: string, filterBy?: string, facetBy?: string, maxFacetValues?: number, widgetMode?: boolean, includeSuggestions?: boolean, suggestionsLimit?: number, analyticsTags?: string, stopwordSets?: string, synonymSets?: string, searchFields?: string, returnFields?: string, omitFields?: string, snippetFields?: string, fullSnippetFields?: string, fieldWeights?: string, groupField?: string, groupSize?: number, snippetPrefix?: string, snippetSuffix?: string, snippetTokenLimit?: number, snippetMinLen?: number, includeSnippets?: boolean, prefixMode?: string, infixMode?: string, typoMax?: number, typoMinLen1?: number, typoMinLen2?: number, searchTimeoutMs?: number, requireAllTerms?: boolean, exactMatchBoost?: boolean, cacheResults?: boolean, applyRules?: boolean, presetName?: string, facetSearchText?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOfficialSearchResponseWrapper, any, {}>>;
|
|
59001
59323
|
/**
|
|
59002
59324
|
* 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.
|
|
59003
59325
|
* @summary Public Search API
|