@seekora-ai/admin-api 1.1.97 → 1.1.99
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -2
- package/api.ts +367 -16
- package/dist/api.d.ts +207 -16
- package/dist/api.js +295 -0
- package/dist/esm/api.d.ts +207 -16
- package/dist/esm/api.js +295 -0
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.1.99.tgz +0 -0
- package/seekora-ai-admin-api-1.1.97.tgz +0 -0
package/dist/api.d.ts
CHANGED
|
@@ -13983,7 +13983,7 @@ export interface DataTypesComponentCheck {
|
|
|
13983
13983
|
*/
|
|
13984
13984
|
export interface DataTypesComponentStatusDetail {
|
|
13985
13985
|
/**
|
|
13986
|
-
*
|
|
13986
|
+
* Search collection exists
|
|
13987
13987
|
* @type {DataTypesComponentCheck}
|
|
13988
13988
|
* @memberof DataTypesComponentStatusDetail
|
|
13989
13989
|
*/
|
|
@@ -17072,7 +17072,7 @@ export interface DataTypesDropdownRecommendationsConfig {
|
|
|
17072
17072
|
*/
|
|
17073
17073
|
'dynamic_tabs_max_count'?: number;
|
|
17074
17074
|
/**
|
|
17075
|
-
* Method: \"groupBy\" (
|
|
17075
|
+
* Method: \"groupBy\" (group results by field), \"facets\" (uses facet discovery), \"manual\" (uses FilteredTabs config only) (default: \"groupBy\")
|
|
17076
17076
|
* @type {string}
|
|
17077
17077
|
* @memberof DataTypesDropdownRecommendationsConfig
|
|
17078
17078
|
*/
|
|
@@ -23962,6 +23962,44 @@ export interface DataTypesModuleResponse {
|
|
|
23962
23962
|
*/
|
|
23963
23963
|
'status'?: number;
|
|
23964
23964
|
}
|
|
23965
|
+
/**
|
|
23966
|
+
*
|
|
23967
|
+
* @export
|
|
23968
|
+
* @interface DataTypesMultiSearchRequest
|
|
23969
|
+
*/
|
|
23970
|
+
export interface DataTypesMultiSearchRequest {
|
|
23971
|
+
/**
|
|
23972
|
+
*
|
|
23973
|
+
* @type {Array<DataTypesSearchRequest>}
|
|
23974
|
+
* @memberof DataTypesMultiSearchRequest
|
|
23975
|
+
*/
|
|
23976
|
+
'searches': Array<DataTypesSearchRequest>;
|
|
23977
|
+
}
|
|
23978
|
+
/**
|
|
23979
|
+
*
|
|
23980
|
+
* @export
|
|
23981
|
+
* @interface DataTypesMultiSearchResponseWrapper
|
|
23982
|
+
*/
|
|
23983
|
+
export interface DataTypesMultiSearchResponseWrapper {
|
|
23984
|
+
/**
|
|
23985
|
+
*
|
|
23986
|
+
* @type {Array<DataTypesSearchResponse>}
|
|
23987
|
+
* @memberof DataTypesMultiSearchResponseWrapper
|
|
23988
|
+
*/
|
|
23989
|
+
'data'?: Array<DataTypesSearchResponse>;
|
|
23990
|
+
/**
|
|
23991
|
+
*
|
|
23992
|
+
* @type {string}
|
|
23993
|
+
* @memberof DataTypesMultiSearchResponseWrapper
|
|
23994
|
+
*/
|
|
23995
|
+
'message'?: string;
|
|
23996
|
+
/**
|
|
23997
|
+
*
|
|
23998
|
+
* @type {number}
|
|
23999
|
+
* @memberof DataTypesMultiSearchResponseWrapper
|
|
24000
|
+
*/
|
|
24001
|
+
'status'?: number;
|
|
24002
|
+
}
|
|
23965
24003
|
/**
|
|
23966
24004
|
*
|
|
23967
24005
|
* @export
|
|
@@ -27752,17 +27790,17 @@ export interface DataTypesQuerySuggestionsConfig {
|
|
|
27752
27790
|
*/
|
|
27753
27791
|
'min_popularity'?: number;
|
|
27754
27792
|
/**
|
|
27755
|
-
* Whether
|
|
27793
|
+
* Whether the search collection is enabled for suggestions
|
|
27756
27794
|
* @type {boolean}
|
|
27757
27795
|
* @memberof DataTypesQuerySuggestionsConfig
|
|
27758
27796
|
*/
|
|
27759
|
-
'
|
|
27797
|
+
'search_index_enabled'?: boolean;
|
|
27760
27798
|
/**
|
|
27761
|
-
* Whether to sync to
|
|
27799
|
+
* Whether to sync enabled suggestions to the search engine
|
|
27762
27800
|
* @type {boolean}
|
|
27763
27801
|
* @memberof DataTypesQuerySuggestionsConfig
|
|
27764
27802
|
*/
|
|
27765
|
-
'
|
|
27803
|
+
'sync_to_index'?: boolean;
|
|
27766
27804
|
/**
|
|
27767
27805
|
* Include auto-generated suggestions
|
|
27768
27806
|
* @type {boolean}
|
|
@@ -29659,6 +29697,12 @@ export interface DataTypesSearchResult {
|
|
|
29659
29697
|
'document'?: {
|
|
29660
29698
|
[key: string]: any;
|
|
29661
29699
|
};
|
|
29700
|
+
/**
|
|
29701
|
+
*
|
|
29702
|
+
* @type {Array<any>}
|
|
29703
|
+
* @memberof DataTypesSearchResult
|
|
29704
|
+
*/
|
|
29705
|
+
'group_key'?: Array<any>;
|
|
29662
29706
|
/**
|
|
29663
29707
|
*
|
|
29664
29708
|
* @type {{ [key: string]: any; }}
|
|
@@ -38317,6 +38361,12 @@ export interface QuerySuggestionsServiceQuerySuggestionConfig {
|
|
|
38317
38361
|
* @memberof QuerySuggestionsServiceQuerySuggestionConfig
|
|
38318
38362
|
*/
|
|
38319
38363
|
'rules'?: Array<QuerySuggestionsServiceQuerySuggestionRule>;
|
|
38364
|
+
/**
|
|
38365
|
+
* Whether the search collection is enabled for suggestions
|
|
38366
|
+
* @type {boolean}
|
|
38367
|
+
* @memberof QuerySuggestionsServiceQuerySuggestionConfig
|
|
38368
|
+
*/
|
|
38369
|
+
'search_index_enabled'?: boolean;
|
|
38320
38370
|
/**
|
|
38321
38371
|
* Query Suggestions with categories - enhanced
|
|
38322
38372
|
* @type {number}
|
|
@@ -38336,17 +38386,11 @@ export interface QuerySuggestionsServiceQuerySuggestionConfig {
|
|
|
38336
38386
|
*/
|
|
38337
38387
|
'stemming_locale'?: string;
|
|
38338
38388
|
/**
|
|
38339
|
-
* Whether to sync enabled suggestions to
|
|
38389
|
+
* Whether to sync enabled suggestions to the search engine
|
|
38340
38390
|
* @type {boolean}
|
|
38341
38391
|
* @memberof QuerySuggestionsServiceQuerySuggestionConfig
|
|
38342
38392
|
*/
|
|
38343
|
-
'
|
|
38344
|
-
/**
|
|
38345
|
-
* Whether to sync to Typesense
|
|
38346
|
-
* @type {boolean}
|
|
38347
|
-
* @memberof QuerySuggestionsServiceQuerySuggestionConfig
|
|
38348
|
-
*/
|
|
38349
|
-
'typesense_collection_enabled'?: boolean;
|
|
38393
|
+
'sync_to_index'?: boolean;
|
|
38350
38394
|
/**
|
|
38351
38395
|
* Index settings
|
|
38352
38396
|
* @type {number}
|
|
@@ -39366,11 +39410,11 @@ export interface QuerySuggestionsServiceUpdateSuggestionConfigRequest {
|
|
|
39366
39410
|
*/
|
|
39367
39411
|
'stemming_locale'?: string;
|
|
39368
39412
|
/**
|
|
39369
|
-
* Enable/disable syncing suggestions to
|
|
39413
|
+
* Enable/disable syncing suggestions to the search engine
|
|
39370
39414
|
* @type {boolean}
|
|
39371
39415
|
* @memberof QuerySuggestionsServiceUpdateSuggestionConfigRequest
|
|
39372
39416
|
*/
|
|
39373
|
-
'
|
|
39417
|
+
'sync_to_index'?: boolean;
|
|
39374
39418
|
/**
|
|
39375
39419
|
* Typo tolerance
|
|
39376
39420
|
* @type {number}
|
|
@@ -60652,6 +60696,19 @@ export declare const QuerySuggestionsApiAxiosParamCreator: (configuration?: Conf
|
|
|
60652
60696
|
* @throws {RequiredError}
|
|
60653
60697
|
*/
|
|
60654
60698
|
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>;
|
|
60699
|
+
/**
|
|
60700
|
+
* Same as GET; use POST to send a JSON body (e.g. complex filtered_tabs). **Auth:** `x-storeid` and `x-storesecret`. Optional personalization headers: `x-user-id`, `x-anon-id`, `x-session-id`. Request body can include query, hitsPerPage, analytics_tags, include_categories, include_facets, filtered_tabs, etc.
|
|
60701
|
+
* @summary Get query suggestions (POST)
|
|
60702
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
60703
|
+
* @param {string} xStoresecret Store read secret
|
|
60704
|
+
* @param {string} [xUserId] User ID for personalization
|
|
60705
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
60706
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
60707
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
|
|
60708
|
+
* @param {*} [options] Override http request option.
|
|
60709
|
+
* @throws {RequiredError}
|
|
60710
|
+
*/
|
|
60711
|
+
v1SuggestionsQueriesPost: (xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, querySuggestionsServiceQuerySuggestionsRequest?: QuerySuggestionsServiceQuerySuggestionsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
60655
60712
|
};
|
|
60656
60713
|
/**
|
|
60657
60714
|
* QuerySuggestionsApi - functional programming interface
|
|
@@ -60700,6 +60757,19 @@ export declare const QuerySuggestionsApiFp: (configuration?: Configuration) => {
|
|
|
60700
60757
|
* @throws {RequiredError}
|
|
60701
60758
|
*/
|
|
60702
60759
|
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>>;
|
|
60760
|
+
/**
|
|
60761
|
+
* Same as GET; use POST to send a JSON body (e.g. complex filtered_tabs). **Auth:** `x-storeid` and `x-storesecret`. Optional personalization headers: `x-user-id`, `x-anon-id`, `x-session-id`. Request body can include query, hitsPerPage, analytics_tags, include_categories, include_facets, filtered_tabs, etc.
|
|
60762
|
+
* @summary Get query suggestions (POST)
|
|
60763
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
60764
|
+
* @param {string} xStoresecret Store read secret
|
|
60765
|
+
* @param {string} [xUserId] User ID for personalization
|
|
60766
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
60767
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
60768
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
|
|
60769
|
+
* @param {*} [options] Override http request option.
|
|
60770
|
+
* @throws {RequiredError}
|
|
60771
|
+
*/
|
|
60772
|
+
v1SuggestionsQueriesPost(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, querySuggestionsServiceQuerySuggestionsRequest?: QuerySuggestionsServiceQuerySuggestionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>>;
|
|
60703
60773
|
};
|
|
60704
60774
|
/**
|
|
60705
60775
|
* QuerySuggestionsApi - factory interface
|
|
@@ -60748,6 +60818,19 @@ export declare const QuerySuggestionsApiFactory: (configuration?: Configuration,
|
|
|
60748
60818
|
* @throws {RequiredError}
|
|
60749
60819
|
*/
|
|
60750
60820
|
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>;
|
|
60821
|
+
/**
|
|
60822
|
+
* Same as GET; use POST to send a JSON body (e.g. complex filtered_tabs). **Auth:** `x-storeid` and `x-storesecret`. Optional personalization headers: `x-user-id`, `x-anon-id`, `x-session-id`. Request body can include query, hitsPerPage, analytics_tags, include_categories, include_facets, filtered_tabs, etc.
|
|
60823
|
+
* @summary Get query suggestions (POST)
|
|
60824
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
60825
|
+
* @param {string} xStoresecret Store read secret
|
|
60826
|
+
* @param {string} [xUserId] User ID for personalization
|
|
60827
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
60828
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
60829
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
|
|
60830
|
+
* @param {*} [options] Override http request option.
|
|
60831
|
+
* @throws {RequiredError}
|
|
60832
|
+
*/
|
|
60833
|
+
v1SuggestionsQueriesPost(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, querySuggestionsServiceQuerySuggestionsRequest?: QuerySuggestionsServiceQuerySuggestionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>;
|
|
60751
60834
|
};
|
|
60752
60835
|
/**
|
|
60753
60836
|
* QuerySuggestionsApi - object-oriented interface
|
|
@@ -60800,6 +60883,20 @@ export declare class QuerySuggestionsApi extends BaseAPI {
|
|
|
60800
60883
|
* @memberof QuerySuggestionsApi
|
|
60801
60884
|
*/
|
|
60802
60885
|
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, {}>>;
|
|
60886
|
+
/**
|
|
60887
|
+
* Same as GET; use POST to send a JSON body (e.g. complex filtered_tabs). **Auth:** `x-storeid` and `x-storesecret`. Optional personalization headers: `x-user-id`, `x-anon-id`, `x-session-id`. Request body can include query, hitsPerPage, analytics_tags, include_categories, include_facets, filtered_tabs, etc.
|
|
60888
|
+
* @summary Get query suggestions (POST)
|
|
60889
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
60890
|
+
* @param {string} xStoresecret Store read secret
|
|
60891
|
+
* @param {string} [xUserId] User ID for personalization
|
|
60892
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
60893
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
60894
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
|
|
60895
|
+
* @param {*} [options] Override http request option.
|
|
60896
|
+
* @throws {RequiredError}
|
|
60897
|
+
* @memberof QuerySuggestionsApi
|
|
60898
|
+
*/
|
|
60899
|
+
v1SuggestionsQueriesPost(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, querySuggestionsServiceQuerySuggestionsRequest?: QuerySuggestionsServiceQuerySuggestionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuerySuggestionsServiceQuerySuggestionsAPIResponse, any, {}>>;
|
|
60803
60900
|
}
|
|
60804
60901
|
/**
|
|
60805
60902
|
* @export
|
|
@@ -63376,6 +63473,16 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
63376
63473
|
* @throws {RequiredError}
|
|
63377
63474
|
*/
|
|
63378
63475
|
v1IndexIndexnameDefaultsGet: (indexname: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63476
|
+
/**
|
|
63477
|
+
* Execute multiple search queries in a single request. Each query is independent and can have its own filters, pagination, and sorting. Maximum 10 queries per request. **Authentication:** Send `x-storeid` and `x-storesecret` headers.
|
|
63478
|
+
* @summary Multi-Search (POST)
|
|
63479
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63480
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
63481
|
+
* @param {DataTypesMultiSearchRequest} dataTypesMultiSearchRequest Array of search queries
|
|
63482
|
+
* @param {*} [options] Override http request option.
|
|
63483
|
+
* @throws {RequiredError}
|
|
63484
|
+
*/
|
|
63485
|
+
v1MultiSearchPost: (xStoreid: string, xStoresecret: string, dataTypesMultiSearchRequest: DataTypesMultiSearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63379
63486
|
/**
|
|
63380
63487
|
* Same as POST search; all parameters are passed as query params. **Authentication:** `x-storeid` and `x-storesecret` headers. Use `q` for the search query; optional params: `page`, `per_page`, `filter_by`, `sort_by`, `facet_by`, `widget_mode`, `include_suggestions`, etc.
|
|
63381
63488
|
* @summary Search (GET)
|
|
@@ -63426,6 +63533,19 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
63426
63533
|
* @throws {RequiredError}
|
|
63427
63534
|
*/
|
|
63428
63535
|
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>;
|
|
63536
|
+
/**
|
|
63537
|
+
* Run a full-text search for your store. **Authentication:** Send `x-storeid` and `x-storesecret` (from Seekora dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports pagination, filters, facets, sorting, snippets, and autocomplete suggestions. Use `widget_mode: true` for lightweight widget results.
|
|
63538
|
+
* @summary Search (POST)
|
|
63539
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63540
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
63541
|
+
* @param {DataTypesSearchRequest} dataTypesSearchRequest Search query, filters, pagination, and options
|
|
63542
|
+
* @param {string} [xUserId] User ID for personalization
|
|
63543
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
63544
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
63545
|
+
* @param {*} [options] Override http request option.
|
|
63546
|
+
* @throws {RequiredError}
|
|
63547
|
+
*/
|
|
63548
|
+
v1SearchPost: (xStoreid: string, xStoresecret: string, dataTypesSearchRequest: DataTypesSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63429
63549
|
};
|
|
63430
63550
|
/**
|
|
63431
63551
|
* SearchApi - functional programming interface
|
|
@@ -63484,6 +63604,16 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
|
63484
63604
|
* @throws {RequiredError}
|
|
63485
63605
|
*/
|
|
63486
63606
|
v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>>;
|
|
63607
|
+
/**
|
|
63608
|
+
* Execute multiple search queries in a single request. Each query is independent and can have its own filters, pagination, and sorting. Maximum 10 queries per request. **Authentication:** Send `x-storeid` and `x-storesecret` headers.
|
|
63609
|
+
* @summary Multi-Search (POST)
|
|
63610
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63611
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
63612
|
+
* @param {DataTypesMultiSearchRequest} dataTypesMultiSearchRequest Array of search queries
|
|
63613
|
+
* @param {*} [options] Override http request option.
|
|
63614
|
+
* @throws {RequiredError}
|
|
63615
|
+
*/
|
|
63616
|
+
v1MultiSearchPost(xStoreid: string, xStoresecret: string, dataTypesMultiSearchRequest: DataTypesMultiSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesMultiSearchResponseWrapper>>;
|
|
63487
63617
|
/**
|
|
63488
63618
|
* Same as POST search; all parameters are passed as query params. **Authentication:** `x-storeid` and `x-storesecret` headers. Use `q` for the search query; optional params: `page`, `per_page`, `filter_by`, `sort_by`, `facet_by`, `widget_mode`, `include_suggestions`, etc.
|
|
63489
63619
|
* @summary Search (GET)
|
|
@@ -63534,6 +63664,19 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
|
63534
63664
|
* @throws {RequiredError}
|
|
63535
63665
|
*/
|
|
63536
63666
|
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<DataTypesSearchResponseWrapper>>;
|
|
63667
|
+
/**
|
|
63668
|
+
* Run a full-text search for your store. **Authentication:** Send `x-storeid` and `x-storesecret` (from Seekora dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports pagination, filters, facets, sorting, snippets, and autocomplete suggestions. Use `widget_mode: true` for lightweight widget results.
|
|
63669
|
+
* @summary Search (POST)
|
|
63670
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63671
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
63672
|
+
* @param {DataTypesSearchRequest} dataTypesSearchRequest Search query, filters, pagination, and options
|
|
63673
|
+
* @param {string} [xUserId] User ID for personalization
|
|
63674
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
63675
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
63676
|
+
* @param {*} [options] Override http request option.
|
|
63677
|
+
* @throws {RequiredError}
|
|
63678
|
+
*/
|
|
63679
|
+
v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesSearchRequest: DataTypesSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSearchResponseWrapper>>;
|
|
63537
63680
|
};
|
|
63538
63681
|
/**
|
|
63539
63682
|
* SearchApi - factory interface
|
|
@@ -63592,6 +63735,16 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
|
|
|
63592
63735
|
* @throws {RequiredError}
|
|
63593
63736
|
*/
|
|
63594
63737
|
v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>;
|
|
63738
|
+
/**
|
|
63739
|
+
* Execute multiple search queries in a single request. Each query is independent and can have its own filters, pagination, and sorting. Maximum 10 queries per request. **Authentication:** Send `x-storeid` and `x-storesecret` headers.
|
|
63740
|
+
* @summary Multi-Search (POST)
|
|
63741
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63742
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
63743
|
+
* @param {DataTypesMultiSearchRequest} dataTypesMultiSearchRequest Array of search queries
|
|
63744
|
+
* @param {*} [options] Override http request option.
|
|
63745
|
+
* @throws {RequiredError}
|
|
63746
|
+
*/
|
|
63747
|
+
v1MultiSearchPost(xStoreid: string, xStoresecret: string, dataTypesMultiSearchRequest: DataTypesMultiSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesMultiSearchResponseWrapper>;
|
|
63595
63748
|
/**
|
|
63596
63749
|
* Same as POST search; all parameters are passed as query params. **Authentication:** `x-storeid` and `x-storesecret` headers. Use `q` for the search query; optional params: `page`, `per_page`, `filter_by`, `sort_by`, `facet_by`, `widget_mode`, `include_suggestions`, etc.
|
|
63597
63750
|
* @summary Search (GET)
|
|
@@ -63642,6 +63795,19 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
|
|
|
63642
63795
|
* @throws {RequiredError}
|
|
63643
63796
|
*/
|
|
63644
63797
|
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<DataTypesSearchResponseWrapper>;
|
|
63798
|
+
/**
|
|
63799
|
+
* Run a full-text search for your store. **Authentication:** Send `x-storeid` and `x-storesecret` (from Seekora dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports pagination, filters, facets, sorting, snippets, and autocomplete suggestions. Use `widget_mode: true` for lightweight widget results.
|
|
63800
|
+
* @summary Search (POST)
|
|
63801
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63802
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
63803
|
+
* @param {DataTypesSearchRequest} dataTypesSearchRequest Search query, filters, pagination, and options
|
|
63804
|
+
* @param {string} [xUserId] User ID for personalization
|
|
63805
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
63806
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
63807
|
+
* @param {*} [options] Override http request option.
|
|
63808
|
+
* @throws {RequiredError}
|
|
63809
|
+
*/
|
|
63810
|
+
v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesSearchRequest: DataTypesSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSearchResponseWrapper>;
|
|
63645
63811
|
};
|
|
63646
63812
|
/**
|
|
63647
63813
|
* SearchApi - object-oriented interface
|
|
@@ -63708,6 +63874,17 @@ export declare class SearchApi extends BaseAPI {
|
|
|
63708
63874
|
* @memberof SearchApi
|
|
63709
63875
|
*/
|
|
63710
63876
|
v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaBasedDefaultsResponseWrapper, any, {}>>;
|
|
63877
|
+
/**
|
|
63878
|
+
* Execute multiple search queries in a single request. Each query is independent and can have its own filters, pagination, and sorting. Maximum 10 queries per request. **Authentication:** Send `x-storeid` and `x-storesecret` headers.
|
|
63879
|
+
* @summary Multi-Search (POST)
|
|
63880
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63881
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
63882
|
+
* @param {DataTypesMultiSearchRequest} dataTypesMultiSearchRequest Array of search queries
|
|
63883
|
+
* @param {*} [options] Override http request option.
|
|
63884
|
+
* @throws {RequiredError}
|
|
63885
|
+
* @memberof SearchApi
|
|
63886
|
+
*/
|
|
63887
|
+
v1MultiSearchPost(xStoreid: string, xStoresecret: string, dataTypesMultiSearchRequest: DataTypesMultiSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesMultiSearchResponseWrapper, any, {}>>;
|
|
63711
63888
|
/**
|
|
63712
63889
|
* Same as POST search; all parameters are passed as query params. **Authentication:** `x-storeid` and `x-storesecret` headers. Use `q` for the search query; optional params: `page`, `per_page`, `filter_by`, `sort_by`, `facet_by`, `widget_mode`, `include_suggestions`, etc.
|
|
63713
63890
|
* @summary Search (GET)
|
|
@@ -63759,6 +63936,20 @@ export declare class SearchApi extends BaseAPI {
|
|
|
63759
63936
|
* @memberof SearchApi
|
|
63760
63937
|
*/
|
|
63761
63938
|
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<DataTypesSearchResponseWrapper, any, {}>>;
|
|
63939
|
+
/**
|
|
63940
|
+
* Run a full-text search for your store. **Authentication:** Send `x-storeid` and `x-storesecret` (from Seekora dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports pagination, filters, facets, sorting, snippets, and autocomplete suggestions. Use `widget_mode: true` for lightweight widget results.
|
|
63941
|
+
* @summary Search (POST)
|
|
63942
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63943
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
63944
|
+
* @param {DataTypesSearchRequest} dataTypesSearchRequest Search query, filters, pagination, and options
|
|
63945
|
+
* @param {string} [xUserId] User ID for personalization
|
|
63946
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
63947
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
63948
|
+
* @param {*} [options] Override http request option.
|
|
63949
|
+
* @throws {RequiredError}
|
|
63950
|
+
* @memberof SearchApi
|
|
63951
|
+
*/
|
|
63952
|
+
v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesSearchRequest: DataTypesSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSearchResponseWrapper, any, {}>>;
|
|
63762
63953
|
}
|
|
63763
63954
|
/**
|
|
63764
63955
|
* StopwordsApi - axios parameter creator
|