@seekora-ai/admin-api 1.1.80 → 1.1.81

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/api.ts CHANGED
@@ -12842,6 +12842,12 @@ export interface DataTypesCombinedSearchResponse {
12842
12842
  * @memberof DataTypesCombinedSearchResponse
12843
12843
  */
12844
12844
  'search_id'?: string;
12845
+ /**
12846
+ * Available sort options based on schema
12847
+ * @type {Array<DataTypesSortOption>}
12848
+ * @memberof DataTypesCombinedSearchResponse
12849
+ */
12850
+ 'sort_options'?: Array<DataTypesSortOption>;
12845
12851
  /**
12846
12852
  *
12847
12853
  * @type {Array<DataTypesAutocompleteSuggestion>}
@@ -15946,6 +15952,12 @@ export interface DataTypesEventPayload {
15946
15952
  * @memberof DataTypesEventPayload
15947
15953
  */
15948
15954
  'connection_type'?: string;
15955
+ /**
15956
+ * add_to_cart, wishlist, purchase, etc.
15957
+ * @type {string}
15958
+ * @memberof DataTypesEventPayload
15959
+ */
15960
+ 'conversion_type'?: string;
15949
15961
  /**
15950
15962
  *
15951
15963
  * @type {string}
@@ -16024,6 +16036,12 @@ export interface DataTypesEventPayload {
16024
16036
  * @memberof DataTypesEventPayload
16025
16037
  */
16026
16038
  'impression_duration_ms'?: number;
16039
+ /**
16040
+ * 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
16041
+ * @type {string}
16042
+ * @memberof DataTypesEventPayload
16043
+ */
16044
+ 'insert_id'?: string;
16027
16045
  /**
16028
16046
  * ============================================================================ Device Context (V3) ============================================================================
16029
16047
  * @type {string}
@@ -16138,6 +16156,12 @@ export interface DataTypesEventPayload {
16138
16156
  * @memberof DataTypesEventPayload
16139
16157
  */
16140
16158
  'products_count'?: number;
16159
+ /**
16160
+ *
16161
+ * @type {number}
16162
+ * @memberof DataTypesEventPayload
16163
+ */
16164
+ 'quantity'?: number;
16141
16165
  /**
16142
16166
  * ============================================================================ Search Event Fields ============================================================================
16143
16167
  * @type {string}
@@ -22714,6 +22738,12 @@ export interface DataTypesOfficialSearchResponse {
22714
22738
  * @memberof DataTypesOfficialSearchResponse
22715
22739
  */
22716
22740
  'search_id'?: string;
22741
+ /**
22742
+ * Available sort options based on schema
22743
+ * @type {Array<DataTypesSortOption>}
22744
+ * @memberof DataTypesOfficialSearchResponse
22745
+ */
22746
+ 'sort_options'?: Array<DataTypesSortOption>;
22717
22747
  /**
22718
22748
  *
22719
22749
  * @type {Array<DataTypesAutocompleteSuggestion>}
@@ -23450,6 +23480,12 @@ export interface DataTypesOrgMemberWithUser {
23450
23480
  * @memberof DataTypesOrgMemberWithUser
23451
23481
  */
23452
23482
  'is_active'?: boolean;
23483
+ /**
23484
+ * True if user is the organization owner (non-deletable)
23485
+ * @type {boolean}
23486
+ * @memberof DataTypesOrgMemberWithUser
23487
+ */
23488
+ 'is_owner'?: boolean;
23453
23489
  /**
23454
23490
  * True if user has custom/user-specific role
23455
23491
  * @type {boolean}
@@ -26308,6 +26344,12 @@ export interface DataTypesRole {
26308
26344
  * @memberof DataTypesRole
26309
26345
  */
26310
26346
  'isDeleted'?: boolean;
26347
+ /**
26348
+ * BOOLEAN, DEFAULT FALSE - TRUE for system-created roles (non-editable)
26349
+ * @type {boolean}
26350
+ * @memberof DataTypesRole
26351
+ */
26352
+ 'isSystemCreated'?: boolean;
26311
26353
  /**
26312
26354
  * BOOLEAN, DEFAULT FALSE - TRUE for user-specific custom roles
26313
26355
  * @type {boolean}
@@ -27743,6 +27785,37 @@ export interface DataTypesSortField {
27743
27785
  */
27744
27786
  'field'?: string;
27745
27787
  }
27788
+ /**
27789
+ *
27790
+ * @export
27791
+ * @interface DataTypesSortOption
27792
+ */
27793
+ export interface DataTypesSortOption {
27794
+ /**
27795
+ * \"asc\" or \"desc\"
27796
+ * @type {string}
27797
+ * @memberof DataTypesSortOption
27798
+ */
27799
+ 'direction'?: string;
27800
+ /**
27801
+ * Field name (e.g., \"price\", \"created_at\")
27802
+ * @type {string}
27803
+ * @memberof DataTypesSortOption
27804
+ */
27805
+ 'field'?: string;
27806
+ /**
27807
+ * Human-readable label (e.g., \"Price: Low to High\")
27808
+ * @type {string}
27809
+ * @memberof DataTypesSortOption
27810
+ */
27811
+ 'label'?: string;
27812
+ /**
27813
+ * Combined value for API (e.g., \"price:asc\")
27814
+ * @type {string}
27815
+ * @memberof DataTypesSortOption
27816
+ */
27817
+ 'value'?: string;
27818
+ }
27746
27819
  /**
27747
27820
  *
27748
27821
  * @export
@@ -35142,6 +35215,12 @@ export interface QuerySuggestionsServiceQuerySuggestionsRequest {
35142
35215
  * @memberof QuerySuggestionsServiceQuerySuggestionsRequest
35143
35216
  */
35144
35217
  'include_categories'?: boolean;
35218
+ /**
35219
+ * Optional: disable parts of dropdown when include_dropdown_recommendations=true (default true = include)
35220
+ * @type {boolean}
35221
+ * @memberof QuerySuggestionsServiceQuerySuggestionsRequest
35222
+ */
35223
+ 'include_dropdown_product_list'?: boolean;
35145
35224
  /**
35146
35225
  * Rich dropdown recommendations (optional, data-agnostic)
35147
35226
  * @type {boolean}
@@ -35160,6 +35239,12 @@ export interface QuerySuggestionsServiceQuerySuggestionsRequest {
35160
35239
  * @memberof QuerySuggestionsServiceQuerySuggestionsRequest
35161
35240
  */
35162
35241
  'include_facets'?: boolean;
35242
+ /**
35243
+ * When false, omit filtered_tabs from dropdown extensions (default true)
35244
+ * @type {boolean}
35245
+ * @memberof QuerySuggestionsServiceQuerySuggestionsRequest
35246
+ */
35247
+ 'include_filtered_tabs'?: boolean;
35163
35248
  /**
35164
35249
  * Max categories per suggestion (default: 3)
35165
35250
  * @type {number}
@@ -74012,29 +74097,38 @@ export const QuerySuggestionsApiAxiosParamCreator = function (configuration?: Co
74012
74097
  };
74013
74098
  },
74014
74099
  /**
74015
- * 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.
74100
+ * 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.
74016
74101
  * @summary Get Query Suggestions
74017
74102
  * @param {string} xStoreid Store ID
74018
74103
  * @param {string} xStoresecret Store Secret
74019
74104
  * @param {string} [xUserId] User ID for personalization (logged-in user)
74020
74105
  * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
74021
74106
  * @param {string} [xSessionId] Session ID for personalization
74022
- * @param {string} [query] Partial query to get suggestions for
74107
+ * @param {string} [query] Partial query to get suggestions for (supports both \&#39;query\&#39; and \&#39;q\&#39;)
74108
+ * @param {string} [q] Alias for \&#39;query\&#39; parameter
74023
74109
  * @param {number} [hitsPerPage] Number of suggestions to return
74024
74110
  * @param {number} [page] Page number for pagination
74025
74111
  * @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
74026
74112
  * @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
74027
74113
  * @param {boolean} [includeCategories] Include category information in suggestions
74028
74114
  * @param {boolean} [includeFacets] Include popular facets/filters information
74115
+ * @param {boolean} [includeDropdownRecommendations] Include rich dropdown recommendations (trending products, filtered tabs)
74116
+ * @param {boolean} [includeDropdownProductList] Include product list in dropdown recommendations
74117
+ * @param {boolean} [includeFilteredTabs] Include filtered tabs in dropdown recommendations
74118
+ * @param {boolean} [includeEmptyQueryRecommendations] Return popular suggestions when query is empty
74029
74119
  * @param {number} [maxCategories] Maximum categories per suggestion
74030
74120
  * @param {number} [maxFacets] Maximum facets per suggestion
74031
74121
  * @param {number} [minPopularity] Minimum popularity threshold
74032
74122
  * @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
74033
74123
  * @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
74124
+ * @param {string} [filteredTabs] URL-encoded JSON array of filtered tab configurations (e.g., [{\\
74125
+ * @param {string} [userId] User ID for personalization (query param fallback, header takes precedence)
74126
+ * @param {string} [anonId] Anonymous ID for personalization (query param fallback, header takes precedence)
74127
+ * @param {string} [sessionId] Session ID for personalization (query param fallback, header takes precedence)
74034
74128
  * @param {*} [options] Override http request option.
74035
74129
  * @throws {RequiredError}
74036
74130
  */
74037
- v1SuggestionsQueriesGet: async (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> => {
74131
+ v1SuggestionsQueriesGet: async (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> => {
74038
74132
  // verify required parameter 'xStoreid' is not null or undefined
74039
74133
  assertParamExists('v1SuggestionsQueriesGet', 'xStoreid', xStoreid)
74040
74134
  // verify required parameter 'xStoresecret' is not null or undefined
@@ -74055,6 +74149,10 @@ export const QuerySuggestionsApiAxiosParamCreator = function (configuration?: Co
74055
74149
  localVarQueryParameter['query'] = query;
74056
74150
  }
74057
74151
 
74152
+ if (q !== undefined) {
74153
+ localVarQueryParameter['q'] = q;
74154
+ }
74155
+
74058
74156
  if (hitsPerPage !== undefined) {
74059
74157
  localVarQueryParameter['hitsPerPage'] = hitsPerPage;
74060
74158
  }
@@ -74079,6 +74177,22 @@ export const QuerySuggestionsApiAxiosParamCreator = function (configuration?: Co
74079
74177
  localVarQueryParameter['include_facets'] = includeFacets;
74080
74178
  }
74081
74179
 
74180
+ if (includeDropdownRecommendations !== undefined) {
74181
+ localVarQueryParameter['include_dropdown_recommendations'] = includeDropdownRecommendations;
74182
+ }
74183
+
74184
+ if (includeDropdownProductList !== undefined) {
74185
+ localVarQueryParameter['include_dropdown_product_list'] = includeDropdownProductList;
74186
+ }
74187
+
74188
+ if (includeFilteredTabs !== undefined) {
74189
+ localVarQueryParameter['include_filtered_tabs'] = includeFilteredTabs;
74190
+ }
74191
+
74192
+ if (includeEmptyQueryRecommendations !== undefined) {
74193
+ localVarQueryParameter['include_empty_query_recommendations'] = includeEmptyQueryRecommendations;
74194
+ }
74195
+
74082
74196
  if (maxCategories !== undefined) {
74083
74197
  localVarQueryParameter['max_categories'] = maxCategories;
74084
74198
  }
@@ -74099,6 +74213,22 @@ export const QuerySuggestionsApiAxiosParamCreator = function (configuration?: Co
74099
74213
  localVarQueryParameter['disable_typo_tolerance'] = disableTypoTolerance;
74100
74214
  }
74101
74215
 
74216
+ if (filteredTabs !== undefined) {
74217
+ localVarQueryParameter['filtered_tabs'] = filteredTabs;
74218
+ }
74219
+
74220
+ if (userId !== undefined) {
74221
+ localVarQueryParameter['user_id'] = userId;
74222
+ }
74223
+
74224
+ if (anonId !== undefined) {
74225
+ localVarQueryParameter['anon_id'] = anonId;
74226
+ }
74227
+
74228
+ if (sessionId !== undefined) {
74229
+ localVarQueryParameter['session_id'] = sessionId;
74230
+ }
74231
+
74102
74232
 
74103
74233
 
74104
74234
  if (xStoreid != null) {
@@ -74126,14 +74256,14 @@ export const QuerySuggestionsApiAxiosParamCreator = function (configuration?: Co
74126
74256
  };
74127
74257
  },
74128
74258
  /**
74129
- * 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.
74259
+ * 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.
74130
74260
  * @summary Post Query Suggestions
74131
74261
  * @param {string} xStoreid Store ID
74132
74262
  * @param {string} xStoresecret Store Secret
74133
74263
  * @param {string} [xUserId] User ID for personalization (logged-in user)
74134
74264
  * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
74135
74265
  * @param {string} [xSessionId] Session ID for personalization
74136
- * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, filtered_tabs, etc.)
74266
+ * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, include_dropdown_recommendations, filtered_tabs, etc.)
74137
74267
  * @param {*} [options] Override http request option.
74138
74268
  * @throws {RequiredError}
74139
74269
  */
@@ -74208,43 +74338,52 @@ export const QuerySuggestionsApiFp = function(configuration?: Configuration) {
74208
74338
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
74209
74339
  },
74210
74340
  /**
74211
- * 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.
74341
+ * 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.
74212
74342
  * @summary Get Query Suggestions
74213
74343
  * @param {string} xStoreid Store ID
74214
74344
  * @param {string} xStoresecret Store Secret
74215
74345
  * @param {string} [xUserId] User ID for personalization (logged-in user)
74216
74346
  * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
74217
74347
  * @param {string} [xSessionId] Session ID for personalization
74218
- * @param {string} [query] Partial query to get suggestions for
74348
+ * @param {string} [query] Partial query to get suggestions for (supports both \&#39;query\&#39; and \&#39;q\&#39;)
74349
+ * @param {string} [q] Alias for \&#39;query\&#39; parameter
74219
74350
  * @param {number} [hitsPerPage] Number of suggestions to return
74220
74351
  * @param {number} [page] Page number for pagination
74221
74352
  * @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
74222
74353
  * @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
74223
74354
  * @param {boolean} [includeCategories] Include category information in suggestions
74224
74355
  * @param {boolean} [includeFacets] Include popular facets/filters information
74356
+ * @param {boolean} [includeDropdownRecommendations] Include rich dropdown recommendations (trending products, filtered tabs)
74357
+ * @param {boolean} [includeDropdownProductList] Include product list in dropdown recommendations
74358
+ * @param {boolean} [includeFilteredTabs] Include filtered tabs in dropdown recommendations
74359
+ * @param {boolean} [includeEmptyQueryRecommendations] Return popular suggestions when query is empty
74225
74360
  * @param {number} [maxCategories] Maximum categories per suggestion
74226
74361
  * @param {number} [maxFacets] Maximum facets per suggestion
74227
74362
  * @param {number} [minPopularity] Minimum popularity threshold
74228
74363
  * @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
74229
74364
  * @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
74365
+ * @param {string} [filteredTabs] URL-encoded JSON array of filtered tab configurations (e.g., [{\\
74366
+ * @param {string} [userId] User ID for personalization (query param fallback, header takes precedence)
74367
+ * @param {string} [anonId] Anonymous ID for personalization (query param fallback, header takes precedence)
74368
+ * @param {string} [sessionId] Session ID for personalization (query param fallback, header takes precedence)
74230
74369
  * @param {*} [options] Override http request option.
74231
74370
  * @throws {RequiredError}
74232
74371
  */
74233
- async 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>> {
74234
- const localVarAxiosArgs = await localVarAxiosParamCreator.v1SuggestionsQueriesGet(xStoreid, xStoresecret, xUserId, xAnonId, xSessionId, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options);
74372
+ async 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>> {
74373
+ const localVarAxiosArgs = await localVarAxiosParamCreator.v1SuggestionsQueriesGet(xStoreid, xStoresecret, xUserId, xAnonId, xSessionId, query, q, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, includeDropdownRecommendations, includeDropdownProductList, includeFilteredTabs, includeEmptyQueryRecommendations, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, filteredTabs, userId, anonId, sessionId, options);
74235
74374
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
74236
74375
  const localVarOperationServerBasePath = operationServerMap['QuerySuggestionsApi.v1SuggestionsQueriesGet']?.[localVarOperationServerIndex]?.url;
74237
74376
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
74238
74377
  },
74239
74378
  /**
74240
- * 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.
74379
+ * 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.
74241
74380
  * @summary Post Query Suggestions
74242
74381
  * @param {string} xStoreid Store ID
74243
74382
  * @param {string} xStoresecret Store Secret
74244
74383
  * @param {string} [xUserId] User ID for personalization (logged-in user)
74245
74384
  * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
74246
74385
  * @param {string} [xSessionId] Session ID for personalization
74247
- * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, filtered_tabs, etc.)
74386
+ * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, include_dropdown_recommendations, filtered_tabs, etc.)
74248
74387
  * @param {*} [options] Override http request option.
74249
74388
  * @throws {RequiredError}
74250
74389
  */
@@ -74276,40 +74415,49 @@ export const QuerySuggestionsApiFactory = function (configuration?: Configuratio
74276
74415
  return localVarFp.v1SuggestionsConfigGet(xStoreid, xStoresecret, options).then((request) => request(axios, basePath));
74277
74416
  },
74278
74417
  /**
74279
- * 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.
74418
+ * 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.
74280
74419
  * @summary Get Query Suggestions
74281
74420
  * @param {string} xStoreid Store ID
74282
74421
  * @param {string} xStoresecret Store Secret
74283
74422
  * @param {string} [xUserId] User ID for personalization (logged-in user)
74284
74423
  * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
74285
74424
  * @param {string} [xSessionId] Session ID for personalization
74286
- * @param {string} [query] Partial query to get suggestions for
74425
+ * @param {string} [query] Partial query to get suggestions for (supports both \&#39;query\&#39; and \&#39;q\&#39;)
74426
+ * @param {string} [q] Alias for \&#39;query\&#39; parameter
74287
74427
  * @param {number} [hitsPerPage] Number of suggestions to return
74288
74428
  * @param {number} [page] Page number for pagination
74289
74429
  * @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
74290
74430
  * @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
74291
74431
  * @param {boolean} [includeCategories] Include category information in suggestions
74292
74432
  * @param {boolean} [includeFacets] Include popular facets/filters information
74433
+ * @param {boolean} [includeDropdownRecommendations] Include rich dropdown recommendations (trending products, filtered tabs)
74434
+ * @param {boolean} [includeDropdownProductList] Include product list in dropdown recommendations
74435
+ * @param {boolean} [includeFilteredTabs] Include filtered tabs in dropdown recommendations
74436
+ * @param {boolean} [includeEmptyQueryRecommendations] Return popular suggestions when query is empty
74293
74437
  * @param {number} [maxCategories] Maximum categories per suggestion
74294
74438
  * @param {number} [maxFacets] Maximum facets per suggestion
74295
74439
  * @param {number} [minPopularity] Minimum popularity threshold
74296
74440
  * @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
74297
74441
  * @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
74442
+ * @param {string} [filteredTabs] URL-encoded JSON array of filtered tab configurations (e.g., [{\\
74443
+ * @param {string} [userId] User ID for personalization (query param fallback, header takes precedence)
74444
+ * @param {string} [anonId] Anonymous ID for personalization (query param fallback, header takes precedence)
74445
+ * @param {string} [sessionId] Session ID for personalization (query param fallback, header takes precedence)
74298
74446
  * @param {*} [options] Override http request option.
74299
74447
  * @throws {RequiredError}
74300
74448
  */
74301
- 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> {
74302
- return localVarFp.v1SuggestionsQueriesGet(xStoreid, xStoresecret, xUserId, xAnonId, xSessionId, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options).then((request) => request(axios, basePath));
74449
+ 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> {
74450
+ return localVarFp.v1SuggestionsQueriesGet(xStoreid, xStoresecret, xUserId, xAnonId, xSessionId, query, q, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, includeDropdownRecommendations, includeDropdownProductList, includeFilteredTabs, includeEmptyQueryRecommendations, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, filteredTabs, userId, anonId, sessionId, options).then((request) => request(axios, basePath));
74303
74451
  },
74304
74452
  /**
74305
- * 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.
74453
+ * 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.
74306
74454
  * @summary Post Query Suggestions
74307
74455
  * @param {string} xStoreid Store ID
74308
74456
  * @param {string} xStoresecret Store Secret
74309
74457
  * @param {string} [xUserId] User ID for personalization (logged-in user)
74310
74458
  * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
74311
74459
  * @param {string} [xSessionId] Session ID for personalization
74312
- * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, filtered_tabs, etc.)
74460
+ * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, include_dropdown_recommendations, filtered_tabs, etc.)
74313
74461
  * @param {*} [options] Override http request option.
74314
74462
  * @throws {RequiredError}
74315
74463
  */
@@ -74340,42 +74488,51 @@ export class QuerySuggestionsApi extends BaseAPI {
74340
74488
  }
74341
74489
 
74342
74490
  /**
74343
- * 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.
74491
+ * 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.
74344
74492
  * @summary Get Query Suggestions
74345
74493
  * @param {string} xStoreid Store ID
74346
74494
  * @param {string} xStoresecret Store Secret
74347
74495
  * @param {string} [xUserId] User ID for personalization (logged-in user)
74348
74496
  * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
74349
74497
  * @param {string} [xSessionId] Session ID for personalization
74350
- * @param {string} [query] Partial query to get suggestions for
74498
+ * @param {string} [query] Partial query to get suggestions for (supports both \&#39;query\&#39; and \&#39;q\&#39;)
74499
+ * @param {string} [q] Alias for \&#39;query\&#39; parameter
74351
74500
  * @param {number} [hitsPerPage] Number of suggestions to return
74352
74501
  * @param {number} [page] Page number for pagination
74353
74502
  * @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
74354
74503
  * @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
74355
74504
  * @param {boolean} [includeCategories] Include category information in suggestions
74356
74505
  * @param {boolean} [includeFacets] Include popular facets/filters information
74506
+ * @param {boolean} [includeDropdownRecommendations] Include rich dropdown recommendations (trending products, filtered tabs)
74507
+ * @param {boolean} [includeDropdownProductList] Include product list in dropdown recommendations
74508
+ * @param {boolean} [includeFilteredTabs] Include filtered tabs in dropdown recommendations
74509
+ * @param {boolean} [includeEmptyQueryRecommendations] Return popular suggestions when query is empty
74357
74510
  * @param {number} [maxCategories] Maximum categories per suggestion
74358
74511
  * @param {number} [maxFacets] Maximum facets per suggestion
74359
74512
  * @param {number} [minPopularity] Minimum popularity threshold
74360
74513
  * @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
74361
74514
  * @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
74515
+ * @param {string} [filteredTabs] URL-encoded JSON array of filtered tab configurations (e.g., [{\\
74516
+ * @param {string} [userId] User ID for personalization (query param fallback, header takes precedence)
74517
+ * @param {string} [anonId] Anonymous ID for personalization (query param fallback, header takes precedence)
74518
+ * @param {string} [sessionId] Session ID for personalization (query param fallback, header takes precedence)
74362
74519
  * @param {*} [options] Override http request option.
74363
74520
  * @throws {RequiredError}
74364
74521
  * @memberof QuerySuggestionsApi
74365
74522
  */
74366
- public 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) {
74367
- return QuerySuggestionsApiFp(this.configuration).v1SuggestionsQueriesGet(xStoreid, xStoresecret, xUserId, xAnonId, xSessionId, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options).then((request) => request(this.axios, this.basePath));
74523
+ public 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) {
74524
+ return QuerySuggestionsApiFp(this.configuration).v1SuggestionsQueriesGet(xStoreid, xStoresecret, xUserId, xAnonId, xSessionId, query, q, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, includeDropdownRecommendations, includeDropdownProductList, includeFilteredTabs, includeEmptyQueryRecommendations, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, filteredTabs, userId, anonId, sessionId, options).then((request) => request(this.axios, this.basePath));
74368
74525
  }
74369
74526
 
74370
74527
  /**
74371
- * 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.
74528
+ * 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.
74372
74529
  * @summary Post Query Suggestions
74373
74530
  * @param {string} xStoreid Store ID
74374
74531
  * @param {string} xStoresecret Store Secret
74375
74532
  * @param {string} [xUserId] User ID for personalization (logged-in user)
74376
74533
  * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
74377
74534
  * @param {string} [xSessionId] Session ID for personalization
74378
- * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, filtered_tabs, etc.)
74535
+ * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, include_dropdown_recommendations, filtered_tabs, etc.)
74379
74536
  * @param {*} [options] Override http request option.
74380
74537
  * @throws {RequiredError}
74381
74538
  * @memberof QuerySuggestionsApi
@@ -81409,6 +81566,252 @@ export const SearchApiAxiosParamCreator = function (configuration?: Configuratio
81409
81566
 
81410
81567
 
81411
81568
 
81569
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
81570
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
81571
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
81572
+
81573
+ return {
81574
+ url: toPathString(localVarUrlObj),
81575
+ options: localVarRequestOptions,
81576
+ };
81577
+ },
81578
+ /**
81579
+ * Search documents using query parameters. Supports all features of POST endpoint.
81580
+ * @summary Public Search API (GET)
81581
+ * @param {string} xStoreid Store ID
81582
+ * @param {string} xStoresecret Store Secret
81583
+ * @param {string} q Search query
81584
+ * @param {string} [xUserId] User ID for personalization
81585
+ * @param {string} [xAnonId] Anonymous ID for personalization
81586
+ * @param {string} [xSessionId] Session ID for personalization
81587
+ * @param {number} [page] Page number (default: 1)
81588
+ * @param {number} [perPage] Items per page (default: 10)
81589
+ * @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
81590
+ * @param {string} [filterBy] Filter string (e.g., category:shirts)
81591
+ * @param {string} [facetBy] Facet fields (comma-separated)
81592
+ * @param {number} [maxFacetValues] Maximum facet values to return
81593
+ * @param {boolean} [widgetMode] Return widget-formatted results
81594
+ * @param {boolean} [includeSuggestions] Include autocomplete suggestions
81595
+ * @param {number} [suggestionsLimit] Number of suggestions to return
81596
+ * @param {string} [analyticsTags] Analytics tags (comma-separated)
81597
+ * @param {string} [stopwordSets] Stopword set IDs (comma-separated)
81598
+ * @param {string} [synonymSets] Synonym set IDs (comma-separated)
81599
+ * @param {string} [searchFields] Fields to search in (comma-separated)
81600
+ * @param {string} [returnFields] Fields to return (comma-separated)
81601
+ * @param {string} [omitFields] Fields to omit (comma-separated)
81602
+ * @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
81603
+ * @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
81604
+ * @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
81605
+ * @param {string} [groupField] Field to group results by
81606
+ * @param {number} [groupSize] Number of results per group
81607
+ * @param {string} [snippetPrefix] Prefix for highlighted snippets
81608
+ * @param {string} [snippetSuffix] Suffix for highlighted snippets
81609
+ * @param {number} [snippetTokenLimit] Maximum tokens in snippet
81610
+ * @param {number} [snippetMinLen] Minimum snippet length
81611
+ * @param {boolean} [includeSnippets] Include snippets in results
81612
+ * @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
81613
+ * @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
81614
+ * @param {number} [typoMax] Maximum typo tolerance
81615
+ * @param {number} [typoMinLen1] Min word length for 1 typo
81616
+ * @param {number} [typoMinLen2] Min word length for 2 typos
81617
+ * @param {number} [searchTimeoutMs] Search timeout in milliseconds
81618
+ * @param {boolean} [requireAllTerms] Require all search terms to match
81619
+ * @param {boolean} [exactMatchBoost] Boost exact matches
81620
+ * @param {boolean} [cacheResults] Cache search results
81621
+ * @param {boolean} [applyRules] Apply search rules
81622
+ * @param {string} [presetName] Search preset name to use
81623
+ * @param {string} [facetSearchText] Text to filter facet values
81624
+ * @param {*} [options] Override http request option.
81625
+ * @throws {RequiredError}
81626
+ */
81627
+ v1SearchGet: async (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> => {
81628
+ // verify required parameter 'xStoreid' is not null or undefined
81629
+ assertParamExists('v1SearchGet', 'xStoreid', xStoreid)
81630
+ // verify required parameter 'xStoresecret' is not null or undefined
81631
+ assertParamExists('v1SearchGet', 'xStoresecret', xStoresecret)
81632
+ // verify required parameter 'q' is not null or undefined
81633
+ assertParamExists('v1SearchGet', 'q', q)
81634
+ const localVarPath = `/v1/search`;
81635
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
81636
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
81637
+ let baseOptions;
81638
+ if (configuration) {
81639
+ baseOptions = configuration.baseOptions;
81640
+ }
81641
+
81642
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
81643
+ const localVarHeaderParameter = {} as any;
81644
+ const localVarQueryParameter = {} as any;
81645
+
81646
+ if (q !== undefined) {
81647
+ localVarQueryParameter['q'] = q;
81648
+ }
81649
+
81650
+ if (page !== undefined) {
81651
+ localVarQueryParameter['page'] = page;
81652
+ }
81653
+
81654
+ if (perPage !== undefined) {
81655
+ localVarQueryParameter['per_page'] = perPage;
81656
+ }
81657
+
81658
+ if (sortBy !== undefined) {
81659
+ localVarQueryParameter['sort_by'] = sortBy;
81660
+ }
81661
+
81662
+ if (filterBy !== undefined) {
81663
+ localVarQueryParameter['filter_by'] = filterBy;
81664
+ }
81665
+
81666
+ if (facetBy !== undefined) {
81667
+ localVarQueryParameter['facet_by'] = facetBy;
81668
+ }
81669
+
81670
+ if (maxFacetValues !== undefined) {
81671
+ localVarQueryParameter['max_facet_values'] = maxFacetValues;
81672
+ }
81673
+
81674
+ if (widgetMode !== undefined) {
81675
+ localVarQueryParameter['widget_mode'] = widgetMode;
81676
+ }
81677
+
81678
+ if (includeSuggestions !== undefined) {
81679
+ localVarQueryParameter['include_suggestions'] = includeSuggestions;
81680
+ }
81681
+
81682
+ if (suggestionsLimit !== undefined) {
81683
+ localVarQueryParameter['suggestions_limit'] = suggestionsLimit;
81684
+ }
81685
+
81686
+ if (analyticsTags !== undefined) {
81687
+ localVarQueryParameter['analytics_tags'] = analyticsTags;
81688
+ }
81689
+
81690
+ if (stopwordSets !== undefined) {
81691
+ localVarQueryParameter['stopword_sets'] = stopwordSets;
81692
+ }
81693
+
81694
+ if (synonymSets !== undefined) {
81695
+ localVarQueryParameter['synonym_sets'] = synonymSets;
81696
+ }
81697
+
81698
+ if (searchFields !== undefined) {
81699
+ localVarQueryParameter['search_fields'] = searchFields;
81700
+ }
81701
+
81702
+ if (returnFields !== undefined) {
81703
+ localVarQueryParameter['return_fields'] = returnFields;
81704
+ }
81705
+
81706
+ if (omitFields !== undefined) {
81707
+ localVarQueryParameter['omit_fields'] = omitFields;
81708
+ }
81709
+
81710
+ if (snippetFields !== undefined) {
81711
+ localVarQueryParameter['snippet_fields'] = snippetFields;
81712
+ }
81713
+
81714
+ if (fullSnippetFields !== undefined) {
81715
+ localVarQueryParameter['full_snippet_fields'] = fullSnippetFields;
81716
+ }
81717
+
81718
+ if (fieldWeights !== undefined) {
81719
+ localVarQueryParameter['field_weights'] = fieldWeights;
81720
+ }
81721
+
81722
+ if (groupField !== undefined) {
81723
+ localVarQueryParameter['group_field'] = groupField;
81724
+ }
81725
+
81726
+ if (groupSize !== undefined) {
81727
+ localVarQueryParameter['group_size'] = groupSize;
81728
+ }
81729
+
81730
+ if (snippetPrefix !== undefined) {
81731
+ localVarQueryParameter['snippet_prefix'] = snippetPrefix;
81732
+ }
81733
+
81734
+ if (snippetSuffix !== undefined) {
81735
+ localVarQueryParameter['snippet_suffix'] = snippetSuffix;
81736
+ }
81737
+
81738
+ if (snippetTokenLimit !== undefined) {
81739
+ localVarQueryParameter['snippet_token_limit'] = snippetTokenLimit;
81740
+ }
81741
+
81742
+ if (snippetMinLen !== undefined) {
81743
+ localVarQueryParameter['snippet_min_len'] = snippetMinLen;
81744
+ }
81745
+
81746
+ if (includeSnippets !== undefined) {
81747
+ localVarQueryParameter['include_snippets'] = includeSnippets;
81748
+ }
81749
+
81750
+ if (prefixMode !== undefined) {
81751
+ localVarQueryParameter['prefix_mode'] = prefixMode;
81752
+ }
81753
+
81754
+ if (infixMode !== undefined) {
81755
+ localVarQueryParameter['infix_mode'] = infixMode;
81756
+ }
81757
+
81758
+ if (typoMax !== undefined) {
81759
+ localVarQueryParameter['typo_max'] = typoMax;
81760
+ }
81761
+
81762
+ if (typoMinLen1 !== undefined) {
81763
+ localVarQueryParameter['typo_min_len_1'] = typoMinLen1;
81764
+ }
81765
+
81766
+ if (typoMinLen2 !== undefined) {
81767
+ localVarQueryParameter['typo_min_len_2'] = typoMinLen2;
81768
+ }
81769
+
81770
+ if (searchTimeoutMs !== undefined) {
81771
+ localVarQueryParameter['search_timeout_ms'] = searchTimeoutMs;
81772
+ }
81773
+
81774
+ if (requireAllTerms !== undefined) {
81775
+ localVarQueryParameter['require_all_terms'] = requireAllTerms;
81776
+ }
81777
+
81778
+ if (exactMatchBoost !== undefined) {
81779
+ localVarQueryParameter['exact_match_boost'] = exactMatchBoost;
81780
+ }
81781
+
81782
+ if (cacheResults !== undefined) {
81783
+ localVarQueryParameter['cache_results'] = cacheResults;
81784
+ }
81785
+
81786
+ if (applyRules !== undefined) {
81787
+ localVarQueryParameter['apply_rules'] = applyRules;
81788
+ }
81789
+
81790
+ if (presetName !== undefined) {
81791
+ localVarQueryParameter['preset_name'] = presetName;
81792
+ }
81793
+
81794
+ if (facetSearchText !== undefined) {
81795
+ localVarQueryParameter['facet_search_text'] = facetSearchText;
81796
+ }
81797
+
81798
+
81799
+
81800
+ if (xStoreid != null) {
81801
+ localVarHeaderParameter['x-storeid'] = String(xStoreid);
81802
+ }
81803
+ if (xStoresecret != null) {
81804
+ localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
81805
+ }
81806
+ if (xUserId != null) {
81807
+ localVarHeaderParameter['x-user-id'] = String(xUserId);
81808
+ }
81809
+ if (xAnonId != null) {
81810
+ localVarHeaderParameter['x-anon-id'] = String(xAnonId);
81811
+ }
81812
+ if (xSessionId != null) {
81813
+ localVarHeaderParameter['x-session-id'] = String(xSessionId);
81814
+ }
81412
81815
  setSearchParams(localVarUrlObj, localVarQueryParameter);
81413
81816
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
81414
81817
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -81570,6 +81973,61 @@ export const SearchApiFp = function(configuration?: Configuration) {
81570
81973
  const localVarOperationServerBasePath = operationServerMap['SearchApi.v1IndexIndexnameDefaultsGet']?.[localVarOperationServerIndex]?.url;
81571
81974
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
81572
81975
  },
81976
+ /**
81977
+ * Search documents using query parameters. Supports all features of POST endpoint.
81978
+ * @summary Public Search API (GET)
81979
+ * @param {string} xStoreid Store ID
81980
+ * @param {string} xStoresecret Store Secret
81981
+ * @param {string} q Search query
81982
+ * @param {string} [xUserId] User ID for personalization
81983
+ * @param {string} [xAnonId] Anonymous ID for personalization
81984
+ * @param {string} [xSessionId] Session ID for personalization
81985
+ * @param {number} [page] Page number (default: 1)
81986
+ * @param {number} [perPage] Items per page (default: 10)
81987
+ * @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
81988
+ * @param {string} [filterBy] Filter string (e.g., category:shirts)
81989
+ * @param {string} [facetBy] Facet fields (comma-separated)
81990
+ * @param {number} [maxFacetValues] Maximum facet values to return
81991
+ * @param {boolean} [widgetMode] Return widget-formatted results
81992
+ * @param {boolean} [includeSuggestions] Include autocomplete suggestions
81993
+ * @param {number} [suggestionsLimit] Number of suggestions to return
81994
+ * @param {string} [analyticsTags] Analytics tags (comma-separated)
81995
+ * @param {string} [stopwordSets] Stopword set IDs (comma-separated)
81996
+ * @param {string} [synonymSets] Synonym set IDs (comma-separated)
81997
+ * @param {string} [searchFields] Fields to search in (comma-separated)
81998
+ * @param {string} [returnFields] Fields to return (comma-separated)
81999
+ * @param {string} [omitFields] Fields to omit (comma-separated)
82000
+ * @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
82001
+ * @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
82002
+ * @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
82003
+ * @param {string} [groupField] Field to group results by
82004
+ * @param {number} [groupSize] Number of results per group
82005
+ * @param {string} [snippetPrefix] Prefix for highlighted snippets
82006
+ * @param {string} [snippetSuffix] Suffix for highlighted snippets
82007
+ * @param {number} [snippetTokenLimit] Maximum tokens in snippet
82008
+ * @param {number} [snippetMinLen] Minimum snippet length
82009
+ * @param {boolean} [includeSnippets] Include snippets in results
82010
+ * @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
82011
+ * @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
82012
+ * @param {number} [typoMax] Maximum typo tolerance
82013
+ * @param {number} [typoMinLen1] Min word length for 1 typo
82014
+ * @param {number} [typoMinLen2] Min word length for 2 typos
82015
+ * @param {number} [searchTimeoutMs] Search timeout in milliseconds
82016
+ * @param {boolean} [requireAllTerms] Require all search terms to match
82017
+ * @param {boolean} [exactMatchBoost] Boost exact matches
82018
+ * @param {boolean} [cacheResults] Cache search results
82019
+ * @param {boolean} [applyRules] Apply search rules
82020
+ * @param {string} [presetName] Search preset name to use
82021
+ * @param {string} [facetSearchText] Text to filter facet values
82022
+ * @param {*} [options] Override http request option.
82023
+ * @throws {RequiredError}
82024
+ */
82025
+ async 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>> {
82026
+ const localVarAxiosArgs = await localVarAxiosParamCreator.v1SearchGet(xStoreid, xStoresecret, q, xUserId, xAnonId, xSessionId, page, perPage, sortBy, filterBy, facetBy, maxFacetValues, widgetMode, includeSuggestions, suggestionsLimit, analyticsTags, stopwordSets, synonymSets, searchFields, returnFields, omitFields, snippetFields, fullSnippetFields, fieldWeights, groupField, groupSize, snippetPrefix, snippetSuffix, snippetTokenLimit, snippetMinLen, includeSnippets, prefixMode, infixMode, typoMax, typoMinLen1, typoMinLen2, searchTimeoutMs, requireAllTerms, exactMatchBoost, cacheResults, applyRules, presetName, facetSearchText, options);
82027
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
82028
+ const localVarOperationServerBasePath = operationServerMap['SearchApi.v1SearchGet']?.[localVarOperationServerIndex]?.url;
82029
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
82030
+ },
81573
82031
  /**
81574
82032
  * 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.
81575
82033
  * @summary Public Search API
@@ -81662,6 +82120,58 @@ export const SearchApiFactory = function (configuration?: Configuration, basePat
81662
82120
  v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper> {
81663
82121
  return localVarFp.v1IndexIndexnameDefaultsGet(indexname, options).then((request) => request(axios, basePath));
81664
82122
  },
82123
+ /**
82124
+ * Search documents using query parameters. Supports all features of POST endpoint.
82125
+ * @summary Public Search API (GET)
82126
+ * @param {string} xStoreid Store ID
82127
+ * @param {string} xStoresecret Store Secret
82128
+ * @param {string} q Search query
82129
+ * @param {string} [xUserId] User ID for personalization
82130
+ * @param {string} [xAnonId] Anonymous ID for personalization
82131
+ * @param {string} [xSessionId] Session ID for personalization
82132
+ * @param {number} [page] Page number (default: 1)
82133
+ * @param {number} [perPage] Items per page (default: 10)
82134
+ * @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
82135
+ * @param {string} [filterBy] Filter string (e.g., category:shirts)
82136
+ * @param {string} [facetBy] Facet fields (comma-separated)
82137
+ * @param {number} [maxFacetValues] Maximum facet values to return
82138
+ * @param {boolean} [widgetMode] Return widget-formatted results
82139
+ * @param {boolean} [includeSuggestions] Include autocomplete suggestions
82140
+ * @param {number} [suggestionsLimit] Number of suggestions to return
82141
+ * @param {string} [analyticsTags] Analytics tags (comma-separated)
82142
+ * @param {string} [stopwordSets] Stopword set IDs (comma-separated)
82143
+ * @param {string} [synonymSets] Synonym set IDs (comma-separated)
82144
+ * @param {string} [searchFields] Fields to search in (comma-separated)
82145
+ * @param {string} [returnFields] Fields to return (comma-separated)
82146
+ * @param {string} [omitFields] Fields to omit (comma-separated)
82147
+ * @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
82148
+ * @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
82149
+ * @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
82150
+ * @param {string} [groupField] Field to group results by
82151
+ * @param {number} [groupSize] Number of results per group
82152
+ * @param {string} [snippetPrefix] Prefix for highlighted snippets
82153
+ * @param {string} [snippetSuffix] Suffix for highlighted snippets
82154
+ * @param {number} [snippetTokenLimit] Maximum tokens in snippet
82155
+ * @param {number} [snippetMinLen] Minimum snippet length
82156
+ * @param {boolean} [includeSnippets] Include snippets in results
82157
+ * @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
82158
+ * @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
82159
+ * @param {number} [typoMax] Maximum typo tolerance
82160
+ * @param {number} [typoMinLen1] Min word length for 1 typo
82161
+ * @param {number} [typoMinLen2] Min word length for 2 typos
82162
+ * @param {number} [searchTimeoutMs] Search timeout in milliseconds
82163
+ * @param {boolean} [requireAllTerms] Require all search terms to match
82164
+ * @param {boolean} [exactMatchBoost] Boost exact matches
82165
+ * @param {boolean} [cacheResults] Cache search results
82166
+ * @param {boolean} [applyRules] Apply search rules
82167
+ * @param {string} [presetName] Search preset name to use
82168
+ * @param {string} [facetSearchText] Text to filter facet values
82169
+ * @param {*} [options] Override http request option.
82170
+ * @throws {RequiredError}
82171
+ */
82172
+ 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> {
82173
+ return localVarFp.v1SearchGet(xStoreid, xStoresecret, q, xUserId, xAnonId, xSessionId, page, perPage, sortBy, filterBy, facetBy, maxFacetValues, widgetMode, includeSuggestions, suggestionsLimit, analyticsTags, stopwordSets, synonymSets, searchFields, returnFields, omitFields, snippetFields, fullSnippetFields, fieldWeights, groupField, groupSize, snippetPrefix, snippetSuffix, snippetTokenLimit, snippetMinLen, includeSnippets, prefixMode, infixMode, typoMax, typoMinLen1, typoMinLen2, searchTimeoutMs, requireAllTerms, exactMatchBoost, cacheResults, applyRules, presetName, facetSearchText, options).then((request) => request(axios, basePath));
82174
+ },
81665
82175
  /**
81666
82176
  * 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.
81667
82177
  * @summary Public Search API
@@ -81763,6 +82273,60 @@ export class SearchApi extends BaseAPI {
81763
82273
  return SearchApiFp(this.configuration).v1IndexIndexnameDefaultsGet(indexname, options).then((request) => request(this.axios, this.basePath));
81764
82274
  }
81765
82275
 
82276
+ /**
82277
+ * Search documents using query parameters. Supports all features of POST endpoint.
82278
+ * @summary Public Search API (GET)
82279
+ * @param {string} xStoreid Store ID
82280
+ * @param {string} xStoresecret Store Secret
82281
+ * @param {string} q Search query
82282
+ * @param {string} [xUserId] User ID for personalization
82283
+ * @param {string} [xAnonId] Anonymous ID for personalization
82284
+ * @param {string} [xSessionId] Session ID for personalization
82285
+ * @param {number} [page] Page number (default: 1)
82286
+ * @param {number} [perPage] Items per page (default: 10)
82287
+ * @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
82288
+ * @param {string} [filterBy] Filter string (e.g., category:shirts)
82289
+ * @param {string} [facetBy] Facet fields (comma-separated)
82290
+ * @param {number} [maxFacetValues] Maximum facet values to return
82291
+ * @param {boolean} [widgetMode] Return widget-formatted results
82292
+ * @param {boolean} [includeSuggestions] Include autocomplete suggestions
82293
+ * @param {number} [suggestionsLimit] Number of suggestions to return
82294
+ * @param {string} [analyticsTags] Analytics tags (comma-separated)
82295
+ * @param {string} [stopwordSets] Stopword set IDs (comma-separated)
82296
+ * @param {string} [synonymSets] Synonym set IDs (comma-separated)
82297
+ * @param {string} [searchFields] Fields to search in (comma-separated)
82298
+ * @param {string} [returnFields] Fields to return (comma-separated)
82299
+ * @param {string} [omitFields] Fields to omit (comma-separated)
82300
+ * @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
82301
+ * @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
82302
+ * @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
82303
+ * @param {string} [groupField] Field to group results by
82304
+ * @param {number} [groupSize] Number of results per group
82305
+ * @param {string} [snippetPrefix] Prefix for highlighted snippets
82306
+ * @param {string} [snippetSuffix] Suffix for highlighted snippets
82307
+ * @param {number} [snippetTokenLimit] Maximum tokens in snippet
82308
+ * @param {number} [snippetMinLen] Minimum snippet length
82309
+ * @param {boolean} [includeSnippets] Include snippets in results
82310
+ * @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
82311
+ * @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
82312
+ * @param {number} [typoMax] Maximum typo tolerance
82313
+ * @param {number} [typoMinLen1] Min word length for 1 typo
82314
+ * @param {number} [typoMinLen2] Min word length for 2 typos
82315
+ * @param {number} [searchTimeoutMs] Search timeout in milliseconds
82316
+ * @param {boolean} [requireAllTerms] Require all search terms to match
82317
+ * @param {boolean} [exactMatchBoost] Boost exact matches
82318
+ * @param {boolean} [cacheResults] Cache search results
82319
+ * @param {boolean} [applyRules] Apply search rules
82320
+ * @param {string} [presetName] Search preset name to use
82321
+ * @param {string} [facetSearchText] Text to filter facet values
82322
+ * @param {*} [options] Override http request option.
82323
+ * @throws {RequiredError}
82324
+ * @memberof SearchApi
82325
+ */
82326
+ public 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) {
82327
+ return SearchApiFp(this.configuration).v1SearchGet(xStoreid, xStoresecret, q, xUserId, xAnonId, xSessionId, page, perPage, sortBy, filterBy, facetBy, maxFacetValues, widgetMode, includeSuggestions, suggestionsLimit, analyticsTags, stopwordSets, synonymSets, searchFields, returnFields, omitFields, snippetFields, fullSnippetFields, fieldWeights, groupField, groupSize, snippetPrefix, snippetSuffix, snippetTokenLimit, snippetMinLen, includeSnippets, prefixMode, infixMode, typoMax, typoMinLen1, typoMinLen2, searchTimeoutMs, requireAllTerms, exactMatchBoost, cacheResults, applyRules, presetName, facetSearchText, options).then((request) => request(this.axios, this.basePath));
82328
+ }
82329
+
81766
82330
  /**
81767
82331
  * 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.
81768
82332
  * @summary Public Search API