@seekora-ai/search-sdk 0.2.7 → 0.2.12

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.
@@ -3168,6 +3168,10 @@ export interface DataTypesCombinedSearchResponse {
3168
3168
  * Unique search identifier for analytics linking
3169
3169
  */
3170
3170
  'search_id'?: string;
3171
+ /**
3172
+ * Available sort options based on schema
3173
+ */
3174
+ 'sort_options'?: Array<DataTypesSortOption>;
3171
3175
  'suggestions'?: Array<DataTypesAutocompleteSuggestion>;
3172
3176
  'total_results'?: number;
3173
3177
  }
@@ -4166,6 +4170,10 @@ export interface DataTypesEventPayload {
4166
4170
  * Connection Context
4167
4171
  */
4168
4172
  'connection_type'?: string;
4173
+ /**
4174
+ * add_to_cart, wishlist, purchase, etc.
4175
+ */
4176
+ 'conversion_type'?: string;
4169
4177
  'correlation_id'?: string;
4170
4178
  /**
4171
4179
  * ============================================================================ Geo Context (V3) ============================================================================
@@ -4188,6 +4196,10 @@ export interface DataTypesEventPayload {
4188
4196
  'has_dropdown'?: number;
4189
4197
  'has_filtered_tabs'?: number;
4190
4198
  'impression_duration_ms'?: number;
4199
+ /**
4200
+ * 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
4201
+ */
4202
+ 'insert_id'?: string;
4191
4203
  /**
4192
4204
  * ============================================================================ Device Context (V3) ============================================================================
4193
4205
  */
@@ -4227,6 +4239,7 @@ export interface DataTypesEventPayload {
4227
4239
  'platform'?: string;
4228
4240
  'position'?: number;
4229
4241
  'products_count'?: number;
4242
+ 'quantity'?: number;
4230
4243
  /**
4231
4244
  * ============================================================================ Search Event Fields ============================================================================
4232
4245
  */
@@ -6136,6 +6149,10 @@ export interface DataTypesOfficialSearchResponse {
6136
6149
  * Unique search identifier for analytics linking
6137
6150
  */
6138
6151
  'search_id'?: string;
6152
+ /**
6153
+ * Available sort options based on schema
6154
+ */
6155
+ 'sort_options'?: Array<DataTypesSortOption>;
6139
6156
  'suggestions'?: Array<DataTypesAutocompleteSuggestion>;
6140
6157
  'total_results'?: number;
6141
6158
  }
@@ -7935,6 +7952,24 @@ export interface DataTypesSortField {
7935
7952
  'direction'?: string;
7936
7953
  'field'?: string;
7937
7954
  }
7955
+ export interface DataTypesSortOption {
7956
+ /**
7957
+ * \"asc\" or \"desc\"
7958
+ */
7959
+ 'direction'?: string;
7960
+ /**
7961
+ * Field name (e.g., \"price\", \"created_at\")
7962
+ */
7963
+ 'field'?: string;
7964
+ /**
7965
+ * Human-readable label (e.g., \"Price: Low to High\")
7966
+ */
7967
+ 'label'?: string;
7968
+ /**
7969
+ * Combined value for API (e.g., \"price:asc\")
7970
+ */
7971
+ 'value'?: string;
7972
+ }
7938
7973
  export interface DataTypesSource {
7939
7974
  'Config'?: string;
7940
7975
  'CreatedAt'?: string;
@@ -11308,38 +11343,47 @@ export declare const QuerySuggestionsApiAxiosParamCreator: (configuration?: Conf
11308
11343
  */
11309
11344
  v1SuggestionsConfigGet: (xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11310
11345
  /**
11311
- * Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering, and configurable time ranges. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
11346
+ * 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.
11312
11347
  * @summary Get Query Suggestions
11313
11348
  * @param {string} xStoreid Store ID
11314
11349
  * @param {string} xStoresecret Store Secret
11315
11350
  * @param {string} [xUserId] User ID for personalization (logged-in user)
11316
11351
  * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
11317
11352
  * @param {string} [xSessionId] Session ID for personalization
11318
- * @param {string} [query] Partial query to get suggestions for
11353
+ * @param {string} [query] Partial query to get suggestions for (supports both \&#39;query\&#39; and \&#39;q\&#39;)
11354
+ * @param {string} [q] Alias for \&#39;query\&#39; parameter
11319
11355
  * @param {number} [hitsPerPage] Number of suggestions to return
11320
11356
  * @param {number} [page] Page number for pagination
11321
11357
  * @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
11322
11358
  * @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
11323
11359
  * @param {boolean} [includeCategories] Include category information in suggestions
11324
11360
  * @param {boolean} [includeFacets] Include popular facets/filters information
11361
+ * @param {boolean} [includeDropdownRecommendations] Include rich dropdown recommendations (trending products, filtered tabs)
11362
+ * @param {boolean} [includeDropdownProductList] Include product list in dropdown recommendations
11363
+ * @param {boolean} [includeFilteredTabs] Include filtered tabs in dropdown recommendations
11364
+ * @param {boolean} [includeEmptyQueryRecommendations] Return popular suggestions when query is empty
11325
11365
  * @param {number} [maxCategories] Maximum categories per suggestion
11326
11366
  * @param {number} [maxFacets] Maximum facets per suggestion
11327
11367
  * @param {number} [minPopularity] Minimum popularity threshold
11328
11368
  * @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
11329
11369
  * @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
11370
+ * @param {string} [filteredTabs] URL-encoded JSON array of filtered tab configurations (e.g., [{\\
11371
+ * @param {string} [userId] User ID for personalization (query param fallback, header takes precedence)
11372
+ * @param {string} [anonId] Anonymous ID for personalization (query param fallback, header takes precedence)
11373
+ * @param {string} [sessionId] Session ID for personalization (query param fallback, header takes precedence)
11330
11374
  * @param {*} [options] Override http request option.
11331
11375
  * @throws {RequiredError}
11332
11376
  */
11333
- 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>;
11377
+ 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>;
11334
11378
  /**
11335
- * Same as GET: retrieve query suggestions with optional body (query, hitsPerPage, analytics_tags, filtered_tabs, etc.). Use POST when sending filtered_tabs or larger payloads. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
11379
+ * 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.
11336
11380
  * @summary Post Query Suggestions
11337
11381
  * @param {string} xStoreid Store ID
11338
11382
  * @param {string} xStoresecret Store Secret
11339
11383
  * @param {string} [xUserId] User ID for personalization (logged-in user)
11340
11384
  * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
11341
11385
  * @param {string} [xSessionId] Session ID for personalization
11342
- * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, filtered_tabs, etc.)
11386
+ * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, include_dropdown_recommendations, filtered_tabs, etc.)
11343
11387
  * @param {*} [options] Override http request option.
11344
11388
  * @throws {RequiredError}
11345
11389
  */
@@ -11359,38 +11403,47 @@ export declare const QuerySuggestionsApiFp: (configuration?: Configuration) => {
11359
11403
  */
11360
11404
  v1SuggestionsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1SuggestionsConfigGet200Response>>;
11361
11405
  /**
11362
- * Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering, and configurable time ranges. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
11406
+ * 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.
11363
11407
  * @summary Get Query Suggestions
11364
11408
  * @param {string} xStoreid Store ID
11365
11409
  * @param {string} xStoresecret Store Secret
11366
11410
  * @param {string} [xUserId] User ID for personalization (logged-in user)
11367
11411
  * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
11368
11412
  * @param {string} [xSessionId] Session ID for personalization
11369
- * @param {string} [query] Partial query to get suggestions for
11413
+ * @param {string} [query] Partial query to get suggestions for (supports both \&#39;query\&#39; and \&#39;q\&#39;)
11414
+ * @param {string} [q] Alias for \&#39;query\&#39; parameter
11370
11415
  * @param {number} [hitsPerPage] Number of suggestions to return
11371
11416
  * @param {number} [page] Page number for pagination
11372
11417
  * @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
11373
11418
  * @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
11374
11419
  * @param {boolean} [includeCategories] Include category information in suggestions
11375
11420
  * @param {boolean} [includeFacets] Include popular facets/filters information
11421
+ * @param {boolean} [includeDropdownRecommendations] Include rich dropdown recommendations (trending products, filtered tabs)
11422
+ * @param {boolean} [includeDropdownProductList] Include product list in dropdown recommendations
11423
+ * @param {boolean} [includeFilteredTabs] Include filtered tabs in dropdown recommendations
11424
+ * @param {boolean} [includeEmptyQueryRecommendations] Return popular suggestions when query is empty
11376
11425
  * @param {number} [maxCategories] Maximum categories per suggestion
11377
11426
  * @param {number} [maxFacets] Maximum facets per suggestion
11378
11427
  * @param {number} [minPopularity] Minimum popularity threshold
11379
11428
  * @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
11380
11429
  * @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
11430
+ * @param {string} [filteredTabs] URL-encoded JSON array of filtered tab configurations (e.g., [{\\
11431
+ * @param {string} [userId] User ID for personalization (query param fallback, header takes precedence)
11432
+ * @param {string} [anonId] Anonymous ID for personalization (query param fallback, header takes precedence)
11433
+ * @param {string} [sessionId] Session ID for personalization (query param fallback, header takes precedence)
11381
11434
  * @param {*} [options] Override http request option.
11382
11435
  * @throws {RequiredError}
11383
11436
  */
11384
- 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>>;
11437
+ 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>>;
11385
11438
  /**
11386
- * Same as GET: retrieve query suggestions with optional body (query, hitsPerPage, analytics_tags, filtered_tabs, etc.). Use POST when sending filtered_tabs or larger payloads. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
11439
+ * 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.
11387
11440
  * @summary Post Query Suggestions
11388
11441
  * @param {string} xStoreid Store ID
11389
11442
  * @param {string} xStoresecret Store Secret
11390
11443
  * @param {string} [xUserId] User ID for personalization (logged-in user)
11391
11444
  * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
11392
11445
  * @param {string} [xSessionId] Session ID for personalization
11393
- * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, filtered_tabs, etc.)
11446
+ * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, include_dropdown_recommendations, filtered_tabs, etc.)
11394
11447
  * @param {*} [options] Override http request option.
11395
11448
  * @throws {RequiredError}
11396
11449
  */
@@ -11410,38 +11463,47 @@ export declare const QuerySuggestionsApiFactory: (configuration?: Configuration,
11410
11463
  */
11411
11464
  v1SuggestionsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): AxiosPromise<V1SuggestionsConfigGet200Response>;
11412
11465
  /**
11413
- * Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering, and configurable time ranges. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
11466
+ * 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.
11414
11467
  * @summary Get Query Suggestions
11415
11468
  * @param {string} xStoreid Store ID
11416
11469
  * @param {string} xStoresecret Store Secret
11417
11470
  * @param {string} [xUserId] User ID for personalization (logged-in user)
11418
11471
  * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
11419
11472
  * @param {string} [xSessionId] Session ID for personalization
11420
- * @param {string} [query] Partial query to get suggestions for
11473
+ * @param {string} [query] Partial query to get suggestions for (supports both \&#39;query\&#39; and \&#39;q\&#39;)
11474
+ * @param {string} [q] Alias for \&#39;query\&#39; parameter
11421
11475
  * @param {number} [hitsPerPage] Number of suggestions to return
11422
11476
  * @param {number} [page] Page number for pagination
11423
11477
  * @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
11424
11478
  * @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
11425
11479
  * @param {boolean} [includeCategories] Include category information in suggestions
11426
11480
  * @param {boolean} [includeFacets] Include popular facets/filters information
11481
+ * @param {boolean} [includeDropdownRecommendations] Include rich dropdown recommendations (trending products, filtered tabs)
11482
+ * @param {boolean} [includeDropdownProductList] Include product list in dropdown recommendations
11483
+ * @param {boolean} [includeFilteredTabs] Include filtered tabs in dropdown recommendations
11484
+ * @param {boolean} [includeEmptyQueryRecommendations] Return popular suggestions when query is empty
11427
11485
  * @param {number} [maxCategories] Maximum categories per suggestion
11428
11486
  * @param {number} [maxFacets] Maximum facets per suggestion
11429
11487
  * @param {number} [minPopularity] Minimum popularity threshold
11430
11488
  * @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
11431
11489
  * @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
11490
+ * @param {string} [filteredTabs] URL-encoded JSON array of filtered tab configurations (e.g., [{\\
11491
+ * @param {string} [userId] User ID for personalization (query param fallback, header takes precedence)
11492
+ * @param {string} [anonId] Anonymous ID for personalization (query param fallback, header takes precedence)
11493
+ * @param {string} [sessionId] Session ID for personalization (query param fallback, header takes precedence)
11432
11494
  * @param {*} [options] Override http request option.
11433
11495
  * @throws {RequiredError}
11434
11496
  */
11435
- 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>;
11497
+ 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>;
11436
11498
  /**
11437
- * Same as GET: retrieve query suggestions with optional body (query, hitsPerPage, analytics_tags, filtered_tabs, etc.). Use POST when sending filtered_tabs or larger payloads. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
11499
+ * 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.
11438
11500
  * @summary Post Query Suggestions
11439
11501
  * @param {string} xStoreid Store ID
11440
11502
  * @param {string} xStoresecret Store Secret
11441
11503
  * @param {string} [xUserId] User ID for personalization (logged-in user)
11442
11504
  * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
11443
11505
  * @param {string} [xSessionId] Session ID for personalization
11444
- * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, filtered_tabs, etc.)
11506
+ * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, include_dropdown_recommendations, filtered_tabs, etc.)
11445
11507
  * @param {*} [options] Override http request option.
11446
11508
  * @throws {RequiredError}
11447
11509
  */
@@ -11461,38 +11523,47 @@ export declare class QuerySuggestionsApi extends BaseAPI {
11461
11523
  */
11462
11524
  v1SuggestionsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V1SuggestionsConfigGet200Response, any, {}>>;
11463
11525
  /**
11464
- * Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering, and configurable time ranges. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
11526
+ * 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.
11465
11527
  * @summary Get Query Suggestions
11466
11528
  * @param {string} xStoreid Store ID
11467
11529
  * @param {string} xStoresecret Store Secret
11468
11530
  * @param {string} [xUserId] User ID for personalization (logged-in user)
11469
11531
  * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
11470
11532
  * @param {string} [xSessionId] Session ID for personalization
11471
- * @param {string} [query] Partial query to get suggestions for
11533
+ * @param {string} [query] Partial query to get suggestions for (supports both \&#39;query\&#39; and \&#39;q\&#39;)
11534
+ * @param {string} [q] Alias for \&#39;query\&#39; parameter
11472
11535
  * @param {number} [hitsPerPage] Number of suggestions to return
11473
11536
  * @param {number} [page] Page number for pagination
11474
11537
  * @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
11475
11538
  * @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
11476
11539
  * @param {boolean} [includeCategories] Include category information in suggestions
11477
11540
  * @param {boolean} [includeFacets] Include popular facets/filters information
11541
+ * @param {boolean} [includeDropdownRecommendations] Include rich dropdown recommendations (trending products, filtered tabs)
11542
+ * @param {boolean} [includeDropdownProductList] Include product list in dropdown recommendations
11543
+ * @param {boolean} [includeFilteredTabs] Include filtered tabs in dropdown recommendations
11544
+ * @param {boolean} [includeEmptyQueryRecommendations] Return popular suggestions when query is empty
11478
11545
  * @param {number} [maxCategories] Maximum categories per suggestion
11479
11546
  * @param {number} [maxFacets] Maximum facets per suggestion
11480
11547
  * @param {number} [minPopularity] Minimum popularity threshold
11481
11548
  * @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
11482
11549
  * @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
11550
+ * @param {string} [filteredTabs] URL-encoded JSON array of filtered tab configurations (e.g., [{\\
11551
+ * @param {string} [userId] User ID for personalization (query param fallback, header takes precedence)
11552
+ * @param {string} [anonId] Anonymous ID for personalization (query param fallback, header takes precedence)
11553
+ * @param {string} [sessionId] Session ID for personalization (query param fallback, header takes precedence)
11483
11554
  * @param {*} [options] Override http request option.
11484
11555
  * @throws {RequiredError}
11485
11556
  */
11486
- 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, {}>>;
11557
+ 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, {}>>;
11487
11558
  /**
11488
- * Same as GET: retrieve query suggestions with optional body (query, hitsPerPage, analytics_tags, filtered_tabs, etc.). Use POST when sending filtered_tabs or larger payloads. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
11559
+ * 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.
11489
11560
  * @summary Post Query Suggestions
11490
11561
  * @param {string} xStoreid Store ID
11491
11562
  * @param {string} xStoresecret Store Secret
11492
11563
  * @param {string} [xUserId] User ID for personalization (logged-in user)
11493
11564
  * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
11494
11565
  * @param {string} [xSessionId] Session ID for personalization
11495
- * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, filtered_tabs, etc.)
11566
+ * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, include_dropdown_recommendations, filtered_tabs, etc.)
11496
11567
  * @param {*} [options] Override http request option.
11497
11568
  * @throws {RequiredError}
11498
11569
  */
@@ -12173,6 +12244,56 @@ export declare class SDKStoreInfoApi extends BaseAPI {
12173
12244
  * SearchApi - axios parameter creator
12174
12245
  */
12175
12246
  export declare const SearchApiAxiosParamCreator: (configuration?: Configuration) => {
12247
+ /**
12248
+ * Search documents using query parameters. Supports all features of POST endpoint.
12249
+ * @summary Public Search API (GET)
12250
+ * @param {string} xStoreid Store ID
12251
+ * @param {string} xStoresecret Store Secret
12252
+ * @param {string} q Search query
12253
+ * @param {string} [xUserId] User ID for personalization
12254
+ * @param {string} [xAnonId] Anonymous ID for personalization
12255
+ * @param {string} [xSessionId] Session ID for personalization
12256
+ * @param {number} [page] Page number (default: 1)
12257
+ * @param {number} [perPage] Items per page (default: 10)
12258
+ * @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
12259
+ * @param {string} [filterBy] Filter string (e.g., category:shirts)
12260
+ * @param {string} [facetBy] Facet fields (comma-separated)
12261
+ * @param {number} [maxFacetValues] Maximum facet values to return
12262
+ * @param {boolean} [widgetMode] Return widget-formatted results
12263
+ * @param {boolean} [includeSuggestions] Include autocomplete suggestions
12264
+ * @param {number} [suggestionsLimit] Number of suggestions to return
12265
+ * @param {string} [analyticsTags] Analytics tags (comma-separated)
12266
+ * @param {string} [stopwordSets] Stopword set IDs (comma-separated)
12267
+ * @param {string} [synonymSets] Synonym set IDs (comma-separated)
12268
+ * @param {string} [searchFields] Fields to search in (comma-separated)
12269
+ * @param {string} [returnFields] Fields to return (comma-separated)
12270
+ * @param {string} [omitFields] Fields to omit (comma-separated)
12271
+ * @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
12272
+ * @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
12273
+ * @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
12274
+ * @param {string} [groupField] Field to group results by
12275
+ * @param {number} [groupSize] Number of results per group
12276
+ * @param {string} [snippetPrefix] Prefix for highlighted snippets
12277
+ * @param {string} [snippetSuffix] Suffix for highlighted snippets
12278
+ * @param {number} [snippetTokenLimit] Maximum tokens in snippet
12279
+ * @param {number} [snippetMinLen] Minimum snippet length
12280
+ * @param {boolean} [includeSnippets] Include snippets in results
12281
+ * @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
12282
+ * @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
12283
+ * @param {number} [typoMax] Maximum typo tolerance
12284
+ * @param {number} [typoMinLen1] Min word length for 1 typo
12285
+ * @param {number} [typoMinLen2] Min word length for 2 typos
12286
+ * @param {number} [searchTimeoutMs] Search timeout in milliseconds
12287
+ * @param {boolean} [requireAllTerms] Require all search terms to match
12288
+ * @param {boolean} [exactMatchBoost] Boost exact matches
12289
+ * @param {boolean} [cacheResults] Cache search results
12290
+ * @param {boolean} [applyRules] Apply search rules
12291
+ * @param {string} [presetName] Search preset name to use
12292
+ * @param {string} [facetSearchText] Text to filter facet values
12293
+ * @param {*} [options] Override http request option.
12294
+ * @throws {RequiredError}
12295
+ */
12296
+ 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>;
12176
12297
  /**
12177
12298
  * 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.
12178
12299
  * @summary Public Search API
@@ -12191,6 +12312,56 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
12191
12312
  * SearchApi - functional programming interface
12192
12313
  */
12193
12314
  export declare const SearchApiFp: (configuration?: Configuration) => {
12315
+ /**
12316
+ * Search documents using query parameters. Supports all features of POST endpoint.
12317
+ * @summary Public Search API (GET)
12318
+ * @param {string} xStoreid Store ID
12319
+ * @param {string} xStoresecret Store Secret
12320
+ * @param {string} q Search query
12321
+ * @param {string} [xUserId] User ID for personalization
12322
+ * @param {string} [xAnonId] Anonymous ID for personalization
12323
+ * @param {string} [xSessionId] Session ID for personalization
12324
+ * @param {number} [page] Page number (default: 1)
12325
+ * @param {number} [perPage] Items per page (default: 10)
12326
+ * @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
12327
+ * @param {string} [filterBy] Filter string (e.g., category:shirts)
12328
+ * @param {string} [facetBy] Facet fields (comma-separated)
12329
+ * @param {number} [maxFacetValues] Maximum facet values to return
12330
+ * @param {boolean} [widgetMode] Return widget-formatted results
12331
+ * @param {boolean} [includeSuggestions] Include autocomplete suggestions
12332
+ * @param {number} [suggestionsLimit] Number of suggestions to return
12333
+ * @param {string} [analyticsTags] Analytics tags (comma-separated)
12334
+ * @param {string} [stopwordSets] Stopword set IDs (comma-separated)
12335
+ * @param {string} [synonymSets] Synonym set IDs (comma-separated)
12336
+ * @param {string} [searchFields] Fields to search in (comma-separated)
12337
+ * @param {string} [returnFields] Fields to return (comma-separated)
12338
+ * @param {string} [omitFields] Fields to omit (comma-separated)
12339
+ * @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
12340
+ * @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
12341
+ * @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
12342
+ * @param {string} [groupField] Field to group results by
12343
+ * @param {number} [groupSize] Number of results per group
12344
+ * @param {string} [snippetPrefix] Prefix for highlighted snippets
12345
+ * @param {string} [snippetSuffix] Suffix for highlighted snippets
12346
+ * @param {number} [snippetTokenLimit] Maximum tokens in snippet
12347
+ * @param {number} [snippetMinLen] Minimum snippet length
12348
+ * @param {boolean} [includeSnippets] Include snippets in results
12349
+ * @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
12350
+ * @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
12351
+ * @param {number} [typoMax] Maximum typo tolerance
12352
+ * @param {number} [typoMinLen1] Min word length for 1 typo
12353
+ * @param {number} [typoMinLen2] Min word length for 2 typos
12354
+ * @param {number} [searchTimeoutMs] Search timeout in milliseconds
12355
+ * @param {boolean} [requireAllTerms] Require all search terms to match
12356
+ * @param {boolean} [exactMatchBoost] Boost exact matches
12357
+ * @param {boolean} [cacheResults] Cache search results
12358
+ * @param {boolean} [applyRules] Apply search rules
12359
+ * @param {string} [presetName] Search preset name to use
12360
+ * @param {string} [facetSearchText] Text to filter facet values
12361
+ * @param {*} [options] Override http request option.
12362
+ * @throws {RequiredError}
12363
+ */
12364
+ 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>>;
12194
12365
  /**
12195
12366
  * 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.
12196
12367
  * @summary Public Search API
@@ -12209,6 +12380,56 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
12209
12380
  * SearchApi - factory interface
12210
12381
  */
12211
12382
  export declare const SearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
12383
+ /**
12384
+ * Search documents using query parameters. Supports all features of POST endpoint.
12385
+ * @summary Public Search API (GET)
12386
+ * @param {string} xStoreid Store ID
12387
+ * @param {string} xStoresecret Store Secret
12388
+ * @param {string} q Search query
12389
+ * @param {string} [xUserId] User ID for personalization
12390
+ * @param {string} [xAnonId] Anonymous ID for personalization
12391
+ * @param {string} [xSessionId] Session ID for personalization
12392
+ * @param {number} [page] Page number (default: 1)
12393
+ * @param {number} [perPage] Items per page (default: 10)
12394
+ * @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
12395
+ * @param {string} [filterBy] Filter string (e.g., category:shirts)
12396
+ * @param {string} [facetBy] Facet fields (comma-separated)
12397
+ * @param {number} [maxFacetValues] Maximum facet values to return
12398
+ * @param {boolean} [widgetMode] Return widget-formatted results
12399
+ * @param {boolean} [includeSuggestions] Include autocomplete suggestions
12400
+ * @param {number} [suggestionsLimit] Number of suggestions to return
12401
+ * @param {string} [analyticsTags] Analytics tags (comma-separated)
12402
+ * @param {string} [stopwordSets] Stopword set IDs (comma-separated)
12403
+ * @param {string} [synonymSets] Synonym set IDs (comma-separated)
12404
+ * @param {string} [searchFields] Fields to search in (comma-separated)
12405
+ * @param {string} [returnFields] Fields to return (comma-separated)
12406
+ * @param {string} [omitFields] Fields to omit (comma-separated)
12407
+ * @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
12408
+ * @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
12409
+ * @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
12410
+ * @param {string} [groupField] Field to group results by
12411
+ * @param {number} [groupSize] Number of results per group
12412
+ * @param {string} [snippetPrefix] Prefix for highlighted snippets
12413
+ * @param {string} [snippetSuffix] Suffix for highlighted snippets
12414
+ * @param {number} [snippetTokenLimit] Maximum tokens in snippet
12415
+ * @param {number} [snippetMinLen] Minimum snippet length
12416
+ * @param {boolean} [includeSnippets] Include snippets in results
12417
+ * @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
12418
+ * @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
12419
+ * @param {number} [typoMax] Maximum typo tolerance
12420
+ * @param {number} [typoMinLen1] Min word length for 1 typo
12421
+ * @param {number} [typoMinLen2] Min word length for 2 typos
12422
+ * @param {number} [searchTimeoutMs] Search timeout in milliseconds
12423
+ * @param {boolean} [requireAllTerms] Require all search terms to match
12424
+ * @param {boolean} [exactMatchBoost] Boost exact matches
12425
+ * @param {boolean} [cacheResults] Cache search results
12426
+ * @param {boolean} [applyRules] Apply search rules
12427
+ * @param {string} [presetName] Search preset name to use
12428
+ * @param {string} [facetSearchText] Text to filter facet values
12429
+ * @param {*} [options] Override http request option.
12430
+ * @throws {RequiredError}
12431
+ */
12432
+ 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>;
12212
12433
  /**
12213
12434
  * 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.
12214
12435
  * @summary Public Search API
@@ -12227,6 +12448,56 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
12227
12448
  * SearchApi - object-oriented interface
12228
12449
  */
12229
12450
  export declare class SearchApi extends BaseAPI {
12451
+ /**
12452
+ * Search documents using query parameters. Supports all features of POST endpoint.
12453
+ * @summary Public Search API (GET)
12454
+ * @param {string} xStoreid Store ID
12455
+ * @param {string} xStoresecret Store Secret
12456
+ * @param {string} q Search query
12457
+ * @param {string} [xUserId] User ID for personalization
12458
+ * @param {string} [xAnonId] Anonymous ID for personalization
12459
+ * @param {string} [xSessionId] Session ID for personalization
12460
+ * @param {number} [page] Page number (default: 1)
12461
+ * @param {number} [perPage] Items per page (default: 10)
12462
+ * @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
12463
+ * @param {string} [filterBy] Filter string (e.g., category:shirts)
12464
+ * @param {string} [facetBy] Facet fields (comma-separated)
12465
+ * @param {number} [maxFacetValues] Maximum facet values to return
12466
+ * @param {boolean} [widgetMode] Return widget-formatted results
12467
+ * @param {boolean} [includeSuggestions] Include autocomplete suggestions
12468
+ * @param {number} [suggestionsLimit] Number of suggestions to return
12469
+ * @param {string} [analyticsTags] Analytics tags (comma-separated)
12470
+ * @param {string} [stopwordSets] Stopword set IDs (comma-separated)
12471
+ * @param {string} [synonymSets] Synonym set IDs (comma-separated)
12472
+ * @param {string} [searchFields] Fields to search in (comma-separated)
12473
+ * @param {string} [returnFields] Fields to return (comma-separated)
12474
+ * @param {string} [omitFields] Fields to omit (comma-separated)
12475
+ * @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
12476
+ * @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
12477
+ * @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
12478
+ * @param {string} [groupField] Field to group results by
12479
+ * @param {number} [groupSize] Number of results per group
12480
+ * @param {string} [snippetPrefix] Prefix for highlighted snippets
12481
+ * @param {string} [snippetSuffix] Suffix for highlighted snippets
12482
+ * @param {number} [snippetTokenLimit] Maximum tokens in snippet
12483
+ * @param {number} [snippetMinLen] Minimum snippet length
12484
+ * @param {boolean} [includeSnippets] Include snippets in results
12485
+ * @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
12486
+ * @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
12487
+ * @param {number} [typoMax] Maximum typo tolerance
12488
+ * @param {number} [typoMinLen1] Min word length for 1 typo
12489
+ * @param {number} [typoMinLen2] Min word length for 2 typos
12490
+ * @param {number} [searchTimeoutMs] Search timeout in milliseconds
12491
+ * @param {boolean} [requireAllTerms] Require all search terms to match
12492
+ * @param {boolean} [exactMatchBoost] Boost exact matches
12493
+ * @param {boolean} [cacheResults] Cache search results
12494
+ * @param {boolean} [applyRules] Apply search rules
12495
+ * @param {string} [presetName] Search preset name to use
12496
+ * @param {string} [facetSearchText] Text to filter facet values
12497
+ * @param {*} [options] Override http request option.
12498
+ * @throws {RequiredError}
12499
+ */
12500
+ 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, {}>>;
12230
12501
  /**
12231
12502
  * 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.
12232
12503
  * @summary Public Search API