@seekora-ai/admin-api 1.0.12 → 1.0.14

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/dist/esm/api.d.ts CHANGED
@@ -13,19 +13,6 @@ import type { Configuration } from './configuration';
13
13
  import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
14
  import type { RequestArgs } from './base';
15
15
  import { BaseAPI } from './base';
16
- /**
17
- *
18
- * @export
19
- * @interface AdminV1UsersOnboardingUploaddataPostRequest
20
- */
21
- export interface AdminV1UsersOnboardingUploaddataPostRequest {
22
- /**
23
- * File
24
- * @type {File}
25
- * @memberof AdminV1UsersOnboardingUploaddataPostRequest
26
- */
27
- 'File': File;
28
- }
29
16
  /**
30
17
  *
31
18
  * @export
@@ -117,6 +104,12 @@ export interface ApiSearchResultHit {
117
104
  * @memberof ApiSearchResultHit
118
105
  */
119
106
  'text_match'?: number;
107
+ /**
108
+ *
109
+ * @type {ApiSearchResultHitTextMatchInfo}
110
+ * @memberof ApiSearchResultHit
111
+ */
112
+ 'text_match_info'?: ApiSearchResultHitTextMatchInfo;
120
113
  /**
121
114
  * VectorDistance Distance between the query vector and matching document\'s vector value
122
115
  * @type {number}
@@ -124,6 +117,55 @@ export interface ApiSearchResultHit {
124
117
  */
125
118
  'vector_distance'?: number;
126
119
  }
120
+ /**
121
+ *
122
+ * @export
123
+ * @interface ApiSearchResultHitTextMatchInfo
124
+ */
125
+ export interface ApiSearchResultHitTextMatchInfo {
126
+ /**
127
+ *
128
+ * @type {string}
129
+ * @memberof ApiSearchResultHitTextMatchInfo
130
+ */
131
+ 'best_field_score'?: string;
132
+ /**
133
+ *
134
+ * @type {number}
135
+ * @memberof ApiSearchResultHitTextMatchInfo
136
+ */
137
+ 'best_field_weight'?: number;
138
+ /**
139
+ *
140
+ * @type {number}
141
+ * @memberof ApiSearchResultHitTextMatchInfo
142
+ */
143
+ 'fields_matched'?: number;
144
+ /**
145
+ *
146
+ * @type {number}
147
+ * @memberof ApiSearchResultHitTextMatchInfo
148
+ */
149
+ 'num_tokens_dropped'?: number;
150
+ /**
151
+ *
152
+ * @type {string}
153
+ * @memberof ApiSearchResultHitTextMatchInfo
154
+ */
155
+ 'score'?: string;
156
+ /**
157
+ *
158
+ * @type {number}
159
+ * @memberof ApiSearchResultHitTextMatchInfo
160
+ */
161
+ 'tokens_matched'?: number;
162
+ /**
163
+ *
164
+ * @type {number}
165
+ * @memberof ApiSearchResultHitTextMatchInfo
166
+ */
167
+ 'typo_prefix_score'?: number;
168
+ }
127
169
  /**
128
170
  *
129
171
  * @export
@@ -311,6 +353,100 @@ export interface DataTypesAPICallsListResponse {
311
353
  */
312
354
  'status'?: number;
313
355
  }
356
+ /**
357
+ *
358
+ * @export
359
+ * @interface DataTypesAdminSearchRequest
360
+ */
361
+ export interface DataTypesAdminSearchRequest {
362
+ /**
363
+ *
364
+ * @type {string}
365
+ * @memberof DataTypesAdminSearchRequest
366
+ */
367
+ 'facet_by'?: string;
368
+ /**
369
+ *
370
+ * @type {string}
371
+ * @memberof DataTypesAdminSearchRequest
372
+ */
373
+ 'filter'?: string;
374
+ /**
375
+ *
376
+ * @type {boolean}
377
+ * @memberof DataTypesAdminSearchRequest
378
+ */
379
+ 'include_suggestions'?: boolean;
380
+ /**
381
+ *
382
+ * @type {number}
383
+ * @memberof DataTypesAdminSearchRequest
384
+ */
385
+ 'max_facet_values'?: number;
386
+ /**
387
+ *
388
+ * @type {DataTypesSearchConfig}
389
+ * @memberof DataTypesAdminSearchRequest
390
+ */
391
+ 'override_config'?: DataTypesSearchConfig;
392
+ /**
393
+ *
394
+ * @type {number}
395
+ * @memberof DataTypesAdminSearchRequest
396
+ */
397
+ 'page'?: number;
398
+ /**
399
+ *
400
+ * @type {number}
401
+ * @memberof DataTypesAdminSearchRequest
402
+ */
403
+ 'per_page'?: number;
404
+ /**
405
+ *
406
+ * @type {string}
407
+ * @memberof DataTypesAdminSearchRequest
408
+ */
409
+ 'q': string;
410
+ /**
411
+ *
412
+ * @type {string}
413
+ * @memberof DataTypesAdminSearchRequest
414
+ */
415
+ 'sort'?: string;
416
+ /**
417
+ *
418
+ * @type {number}
419
+ * @memberof DataTypesAdminSearchRequest
420
+ */
421
+ 'suggestions_limit'?: number;
422
+ }
423
+ /**
424
+ *
425
+ * @export
426
+ * @interface DataTypesAutocompleteSuggestion
427
+ */
428
+ export interface DataTypesAutocompleteSuggestion {
429
+ /**
430
+ *
431
+ * @type {{ [key: string]: any; }}
432
+ * @memberof DataTypesAutocompleteSuggestion
433
+ */
434
+ 'highlight'?: {
435
+ [key: string]: any;
436
+ };
437
+ /**
438
+ *
439
+ * @type {number}
440
+ * @memberof DataTypesAutocompleteSuggestion
441
+ */
442
+ 'score'?: number;
443
+ /**
444
+ *
445
+ * @type {string}
446
+ * @memberof DataTypesAutocompleteSuggestion
447
+ */
448
+ 'text'?: string;
449
+ }
314
450
  /**
315
451
  *
316
452
  * @export
@@ -1134,6 +1270,31 @@ export interface DataTypesIndexConfig {
1134
1270
  */
1135
1271
  'version'?: number;
1136
1272
  }
1273
+ /**
1274
+ *
1275
+ * @export
1276
+ * @interface DataTypesIndexConfigResponse
1277
+ */
1278
+ export interface DataTypesIndexConfigResponse {
1279
+ /**
1280
+ *
1281
+ * @type {DataTypesIndexConfig}
1282
+ * @memberof DataTypesIndexConfigResponse
1283
+ */
1284
+ 'data'?: DataTypesIndexConfig;
1285
+ /**
1286
+ *
1287
+ * @type {string}
1288
+ * @memberof DataTypesIndexConfigResponse
1289
+ */
1290
+ 'message'?: string;
1291
+ /**
1292
+ *
1293
+ * @type {number}
1294
+ * @memberof DataTypesIndexConfigResponse
1295
+ */
1296
+ 'status'?: number;
1297
+ }
1137
1298
  /**
1138
1299
  *
1139
1300
  * @export
@@ -1912,6 +2073,109 @@ export interface DataTypesOTPPayload {
1912
2073
  */
1913
2074
  'otp'?: string;
1914
2075
  }
2076
+ /**
2077
+ *
2078
+ * @export
2079
+ * @interface DataTypesOfficialSearchResponse
2080
+ */
2081
+ export interface DataTypesOfficialSearchResponse {
2082
+ /**
2083
+ *
2084
+ * @type {object}
2085
+ * @memberof DataTypesOfficialSearchResponse
2086
+ */
2087
+ 'facets'?: object;
2088
+ /**
2089
+ *
2090
+ * @type {number}
2091
+ * @memberof DataTypesOfficialSearchResponse
2092
+ */
2093
+ 'page'?: number;
2094
+ /**
2095
+ *
2096
+ * @type {number}
2097
+ * @memberof DataTypesOfficialSearchResponse
2098
+ */
2099
+ 'per_page'?: number;
2100
+ /**
2101
+ *
2102
+ * @type {Array<DataTypesOfficialSearchResult>}
2103
+ * @memberof DataTypesOfficialSearchResponse
2104
+ */
2105
+ 'results'?: Array<DataTypesOfficialSearchResult>;
2106
+ /**
2107
+ *
2108
+ * @type {Array<DataTypesAutocompleteSuggestion>}
2109
+ * @memberof DataTypesOfficialSearchResponse
2110
+ */
2111
+ 'suggestions'?: Array<DataTypesAutocompleteSuggestion>;
2112
+ /**
2113
+ *
2114
+ * @type {number}
2115
+ * @memberof DataTypesOfficialSearchResponse
2116
+ */
2117
+ 'total_results'?: number;
2118
+ }
2119
+ /**
2120
+ *
2121
+ * @export
2122
+ * @interface DataTypesOfficialSearchResponseWrapper
2123
+ */
2124
+ export interface DataTypesOfficialSearchResponseWrapper {
2125
+ /**
2126
+ *
2127
+ * @type {DataTypesOfficialSearchResponse}
2128
+ * @memberof DataTypesOfficialSearchResponseWrapper
2129
+ */
2130
+ 'data'?: DataTypesOfficialSearchResponse;
2131
+ /**
2132
+ *
2133
+ * @type {string}
2134
+ * @memberof DataTypesOfficialSearchResponseWrapper
2135
+ */
2136
+ 'message'?: string;
2137
+ /**
2138
+ *
2139
+ * @type {number}
2140
+ * @memberof DataTypesOfficialSearchResponseWrapper
2141
+ */
2142
+ 'status'?: number;
2143
+ }
2144
+ /**
2145
+ *
2146
+ * @export
2147
+ * @interface DataTypesOfficialSearchResult
2148
+ */
2149
+ export interface DataTypesOfficialSearchResult {
2150
+ /**
2151
+ *
2152
+ * @type {{ [key: string]: any; }}
2153
+ * @memberof DataTypesOfficialSearchResult
2154
+ */
2155
+ 'document'?: {
2156
+ [key: string]: any;
2157
+ };
2158
+ /**
2159
+ *
2160
+ * @type {{ [key: string]: any; }}
2161
+ * @memberof DataTypesOfficialSearchResult
2162
+ */
2163
+ 'highlight'?: {
2164
+ [key: string]: any;
2165
+ };
2166
+ /**
2167
+ *
2168
+ * @type {string}
2169
+ * @memberof DataTypesOfficialSearchResult
2170
+ */
2171
+ 'id'?: string;
2172
+ /**
2173
+ *
2174
+ * @type {number}
2175
+ * @memberof DataTypesOfficialSearchResult
2176
+ */
2177
+ 'score'?: number;
2178
+ }
1915
2179
  /**
1916
2180
  *
1917
2181
  * @export
@@ -2625,6 +2889,67 @@ export interface DataTypesPlansListResponse {
2625
2889
  */
2626
2890
  'status'?: number;
2627
2891
  }
2892
+ /**
2893
+ *
2894
+ * @export
2895
+ * @interface DataTypesPublicSearchRequest
2896
+ */
2897
+ export interface DataTypesPublicSearchRequest {
2898
+ /**
2899
+ *
2900
+ * @type {string}
2901
+ * @memberof DataTypesPublicSearchRequest
2902
+ */
2903
+ 'facet_by'?: string;
2904
+ /**
2905
+ *
2906
+ * @type {string}
2907
+ * @memberof DataTypesPublicSearchRequest
2908
+ */
2909
+ 'filter'?: string;
2910
+ /**
2911
+ *
2912
+ * @type {boolean}
2913
+ * @memberof DataTypesPublicSearchRequest
2914
+ */
2915
+ 'include_suggestions'?: boolean;
2916
+ /**
2917
+ *
2918
+ * @type {number}
2919
+ * @memberof DataTypesPublicSearchRequest
2920
+ */
2921
+ 'max_facet_values'?: number;
2922
+ /**
2923
+ *
2924
+ * @type {number}
2925
+ * @memberof DataTypesPublicSearchRequest
2926
+ */
2927
+ 'page'?: number;
2928
+ /**
2929
+ *
2930
+ * @type {number}
2931
+ * @memberof DataTypesPublicSearchRequest
2932
+ */
2933
+ 'per_page'?: number;
2934
+ /**
2935
+ *
2936
+ * @type {string}
2937
+ * @memberof DataTypesPublicSearchRequest
2938
+ */
2939
+ 'q': string;
2940
+ /**
2941
+ *
2942
+ * @type {string}
2943
+ * @memberof DataTypesPublicSearchRequest
2944
+ */
2945
+ 'sort'?: string;
2946
+ /**
2947
+ *
2948
+ * @type {number}
2949
+ * @memberof DataTypesPublicSearchRequest
2950
+ */
2951
+ 'suggestions_limit'?: number;
2952
+ }
2628
2953
  /**
2629
2954
  *
2630
2955
  * @export
@@ -2993,12 +3318,24 @@ export interface DataTypesSampleDatasetResponse {
2993
3318
  * @memberof DataTypesSampleDatasetResponse
2994
3319
  */
2995
3320
  'imageUrl'?: string;
3321
+ /**
3322
+ *
3323
+ * @type {number}
3324
+ * @memberof DataTypesSampleDatasetResponse
3325
+ */
3326
+ 'sampleDatasetId'?: number;
2996
3327
  /**
2997
3328
  *
2998
3329
  * @type {string}
2999
3330
  * @memberof DataTypesSampleDatasetResponse
3000
3331
  */
3001
3332
  'storeName'?: string;
3333
+ /**
3334
+ *
3335
+ * @type {Array<string>}
3336
+ * @memberof DataTypesSampleDatasetResponse
3337
+ */
3338
+ 'tags'?: Array<string>;
3002
3339
  }
3003
3340
  /**
3004
3341
  *
@@ -3075,6 +3412,63 @@ export interface DataTypesSchemaOptionsResponseWrapper {
3075
3412
  */
3076
3413
  'status'?: number;
3077
3414
  }
3415
+ /**
3416
+ *
3417
+ * @export
3418
+ * @interface DataTypesSearchConfig
3419
+ */
3420
+ export interface DataTypesSearchConfig {
3421
+ /**
3422
+ *
3423
+ * @type {Array<string>}
3424
+ * @memberof DataTypesSearchConfig
3425
+ */
3426
+ 'attributesToHighlight'?: Array<string>;
3427
+ /**
3428
+ *
3429
+ * @type {Array<string>}
3430
+ * @memberof DataTypesSearchConfig
3431
+ */
3432
+ 'attributesToRetrieve'?: Array<string>;
3433
+ /**
3434
+ *
3435
+ * @type {{ [key: string]: any; }}
3436
+ * @memberof DataTypesSearchConfig
3437
+ */
3438
+ 'displayAttributes'?: {
3439
+ [key: string]: any;
3440
+ };
3441
+ /**
3442
+ *
3443
+ * @type {number}
3444
+ * @memberof DataTypesSearchConfig
3445
+ */
3446
+ 'hitsPerPage'?: number;
3447
+ /**
3448
+ *
3449
+ * @type {number}
3450
+ * @memberof DataTypesSearchConfig
3451
+ */
3452
+ 'maxNbHits'?: number;
3453
+ /**
3454
+ *
3455
+ * @type {string}
3456
+ * @memberof DataTypesSearchConfig
3457
+ */
3458
+ 'query_by'?: string;
3459
+ /**
3460
+ *
3461
+ * @type {Array<string>}
3462
+ * @memberof DataTypesSearchConfig
3463
+ */
3464
+ 'ranking'?: Array<string>;
3465
+ /**
3466
+ *
3467
+ * @type {Array<string>}
3468
+ * @memberof DataTypesSearchConfig
3469
+ */
3470
+ 'searchableAttributes'?: Array<string>;
3471
+ }
3078
3472
  /**
3079
3473
  *
3080
3474
  * @export
@@ -3503,6 +3897,12 @@ export interface DataTypesStore {
3503
3897
  * @memberof DataTypesStore
3504
3898
  */
3505
3899
  'StoreName'?: string;
3900
+ /**
3901
+ * Store alias
3902
+ * @type {string}
3903
+ * @memberof DataTypesStore
3904
+ */
3905
+ 'alias'?: string;
3506
3906
  }
3507
3907
  /**
3508
3908
  *
@@ -6841,11 +7241,11 @@ export declare const OnboardingApiAxiosParamCreator: (configuration?: Configurat
6841
7241
  /**
6842
7242
  * Upload source data
6843
7243
  * @summary Upload source data
6844
- * @param {AdminV1UsersOnboardingUploaddataPostRequest} adminV1UsersOnboardingUploaddataPostRequest
7244
+ * @param {File} file File
6845
7245
  * @param {*} [options] Override http request option.
6846
7246
  * @throws {RequiredError}
6847
7247
  */
6848
- adminV1UsersOnboardingUploaddataPost: (adminV1UsersOnboardingUploaddataPostRequest: AdminV1UsersOnboardingUploaddataPostRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7248
+ adminV1UsersOnboardingUploaddataPost: (file: File, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6849
7249
  /**
6850
7250
  * Get sample datasets
6851
7251
  * @summary Get sample datasets
@@ -6915,11 +7315,11 @@ export declare const OnboardingApiFp: (configuration?: Configuration) => {
6915
7315
  /**
6916
7316
  * Upload source data
6917
7317
  * @summary Upload source data
6918
- * @param {AdminV1UsersOnboardingUploaddataPostRequest} adminV1UsersOnboardingUploaddataPostRequest
7318
+ * @param {File} file File
6919
7319
  * @param {*} [options] Override http request option.
6920
7320
  * @throws {RequiredError}
6921
7321
  */
6922
- adminV1UsersOnboardingUploaddataPost(adminV1UsersOnboardingUploaddataPostRequest: AdminV1UsersOnboardingUploaddataPostRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesUploadSourceDataResponseWrapper>>;
7322
+ adminV1UsersOnboardingUploaddataPost(file: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesUploadSourceDataResponseWrapper>>;
6923
7323
  /**
6924
7324
  * Get sample datasets
6925
7325
  * @summary Get sample datasets
@@ -6989,11 +7389,11 @@ export declare const OnboardingApiFactory: (configuration?: Configuration, baseP
6989
7389
  /**
6990
7390
  * Upload source data
6991
7391
  * @summary Upload source data
6992
- * @param {AdminV1UsersOnboardingUploaddataPostRequest} adminV1UsersOnboardingUploaddataPostRequest
7392
+ * @param {File} file File
6993
7393
  * @param {*} [options] Override http request option.
6994
7394
  * @throws {RequiredError}
6995
7395
  */
6996
- adminV1UsersOnboardingUploaddataPost(adminV1UsersOnboardingUploaddataPostRequest: AdminV1UsersOnboardingUploaddataPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesUploadSourceDataResponseWrapper>;
7396
+ adminV1UsersOnboardingUploaddataPost(file: File, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesUploadSourceDataResponseWrapper>;
6997
7397
  /**
6998
7398
  * Get sample datasets
6999
7399
  * @summary Get sample datasets
@@ -7072,12 +7472,12 @@ export declare class OnboardingApi extends BaseAPI {
7072
7472
  /**
7073
7473
  * Upload source data
7074
7474
  * @summary Upload source data
7075
- * @param {AdminV1UsersOnboardingUploaddataPostRequest} adminV1UsersOnboardingUploaddataPostRequest
7475
+ * @param {File} file File
7076
7476
  * @param {*} [options] Override http request option.
7077
7477
  * @throws {RequiredError}
7078
7478
  * @memberof OnboardingApi
7079
7479
  */
7080
- adminV1UsersOnboardingUploaddataPost(adminV1UsersOnboardingUploaddataPostRequest: AdminV1UsersOnboardingUploaddataPostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesUploadSourceDataResponseWrapper, any>>;
7480
+ adminV1UsersOnboardingUploaddataPost(file: File, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesUploadSourceDataResponseWrapper, any>>;
7081
7481
  /**
7082
7482
  * Get sample datasets
7083
7483
  * @summary Get sample datasets
@@ -8703,49 +9103,52 @@ export declare class RolesApi extends BaseAPI {
8703
9103
  */
8704
9104
  export declare const SearchApiAxiosParamCreator: (configuration?: Configuration) => {
8705
9105
  /**
8706
- * Configure the index for search
8707
- * @summary Index Config
8708
- * @param {string} xStoreid Store ID
8709
- * @param {string} xStoresecret Store Secret
8710
- * @param {DataTypesIndexConfig} body Index configuration
9106
+ * Search documents with optional configuration override and autocomplete suggestions
9107
+ * @summary Admin Search API
9108
+ * @param {string} xStoreID Store ID for the selected store
9109
+ * @param {string} xStoreSecret Store Secret for the selected store
9110
+ * @param {DataTypesAdminSearchRequest} body Admin search request (set include_suggestions: true for autocomplete)
8711
9111
  * @param {*} [options] Override http request option.
8712
9112
  * @throws {RequiredError}
8713
9113
  */
8714
- v1IndexConfigPost: (xStoreid: string, xStoresecret: string, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9114
+ adminV1SearchPost: (xStoreID: string, xStoreSecret: string, body: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8715
9115
  /**
8716
- * Update a single property of the index configuration
8717
- * @summary Update Index Config Property
8718
- * @param {string} xStoreid Store ID
8719
- * @param {string} xStoresecret Store Secret
8720
- * @param {string} property Property name
8721
- * @param {object} body Property value
9116
+ * Get the current index configuration
9117
+ * @summary Get Index Config
9118
+ * @param {string} indexname Index Name
8722
9119
  * @param {*} [options] Override http request option.
8723
9120
  * @throws {RequiredError}
8724
9121
  */
8725
- v1IndexConfigPropertyPatch: (xStoreid: string, xStoresecret: string, property: string, body: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9122
+ v1IndexIndexnameConfigGet: (indexname: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8726
9123
  /**
8727
9124
  * Configure the index for search
8728
9125
  * @summary Index Config
8729
- * @param {string} xStoreid Store ID
8730
- * @param {string} xStoresecret Store Secret
8731
9126
  * @param {string} indexname Index Name
8732
9127
  * @param {DataTypesIndexConfig} body Index configuration
8733
9128
  * @param {*} [options] Override http request option.
8734
9129
  * @throws {RequiredError}
8735
9130
  */
8736
- v1IndexIndexnameConfigPost: (xStoreid: string, xStoresecret: string, indexname: string, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9131
+ v1IndexIndexnameConfigPost: (indexname: string, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8737
9132
  /**
8738
9133
  * Update a single property of the index configuration
8739
9134
  * @summary Update Index Config Property
8740
- * @param {string} xStoreid Store ID
8741
- * @param {string} xStoresecret Store Secret
8742
9135
  * @param {string} indexname Index Name
8743
9136
  * @param {string} property Property name
8744
9137
  * @param {object} body Property value
8745
9138
  * @param {*} [options] Override http request option.
8746
9139
  * @throws {RequiredError}
8747
9140
  */
8748
- v1IndexIndexnameConfigPropertyPatch: (xStoreid: string, xStoresecret: string, indexname: string, property: string, body: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9141
+ v1IndexIndexnameConfigPropertyPatch: (indexname: string, property: string, body: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9142
+ /**
9143
+ * Search documents using store credentials with optional autocomplete suggestions
9144
+ * @summary Public Search API
9145
+ * @param {string} xStoreID Store ID
9146
+ * @param {string} xStoreSecret Store Secret
9147
+ * @param {DataTypesPublicSearchRequest} body Search request (set include_suggestions: true for autocomplete)
9148
+ * @param {*} [options] Override http request option.
9149
+ * @throws {RequiredError}
9150
+ */
9151
+ v1SearchPost: (xStoreID: string, xStoreSecret: string, body: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8749
9152
  };
8750
9153
  /**
8751
9154
  * SearchApi - functional programming interface
@@ -8753,49 +9156,52 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
8753
9156
  */
8754
9157
  export declare const SearchApiFp: (configuration?: Configuration) => {
8755
9158
  /**
8756
- * Configure the index for search
8757
- * @summary Index Config
8758
- * @param {string} xStoreid Store ID
8759
- * @param {string} xStoresecret Store Secret
8760
- * @param {DataTypesIndexConfig} body Index configuration
9159
+ * Search documents with optional configuration override and autocomplete suggestions
9160
+ * @summary Admin Search API
9161
+ * @param {string} xStoreID Store ID for the selected store
9162
+ * @param {string} xStoreSecret Store Secret for the selected store
9163
+ * @param {DataTypesAdminSearchRequest} body Admin search request (set include_suggestions: true for autocomplete)
8761
9164
  * @param {*} [options] Override http request option.
8762
9165
  * @throws {RequiredError}
8763
9166
  */
8764
- v1IndexConfigPost(xStoreid: string, xStoresecret: string, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
9167
+ adminV1SearchPost(xStoreID: string, xStoreSecret: string, body: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOfficialSearchResponseWrapper>>;
8765
9168
  /**
8766
- * Update a single property of the index configuration
8767
- * @summary Update Index Config Property
8768
- * @param {string} xStoreid Store ID
8769
- * @param {string} xStoresecret Store Secret
8770
- * @param {string} property Property name
8771
- * @param {object} body Property value
9169
+ * Get the current index configuration
9170
+ * @summary Get Index Config
9171
+ * @param {string} indexname Index Name
8772
9172
  * @param {*} [options] Override http request option.
8773
9173
  * @throws {RequiredError}
8774
9174
  */
8775
- v1IndexConfigPropertyPatch(xStoreid: string, xStoresecret: string, property: string, body: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
9175
+ v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponse>>;
8776
9176
  /**
8777
9177
  * Configure the index for search
8778
9178
  * @summary Index Config
8779
- * @param {string} xStoreid Store ID
8780
- * @param {string} xStoresecret Store Secret
8781
9179
  * @param {string} indexname Index Name
8782
9180
  * @param {DataTypesIndexConfig} body Index configuration
8783
9181
  * @param {*} [options] Override http request option.
8784
9182
  * @throws {RequiredError}
8785
9183
  */
8786
- v1IndexIndexnameConfigPost(xStoreid: string, xStoresecret: string, indexname: string, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
9184
+ v1IndexIndexnameConfigPost(indexname: string, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
8787
9185
  /**
8788
9186
  * Update a single property of the index configuration
8789
9187
  * @summary Update Index Config Property
8790
- * @param {string} xStoreid Store ID
8791
- * @param {string} xStoresecret Store Secret
8792
9188
  * @param {string} indexname Index Name
8793
9189
  * @param {string} property Property name
8794
9190
  * @param {object} body Property value
8795
9191
  * @param {*} [options] Override http request option.
8796
9192
  * @throws {RequiredError}
8797
9193
  */
8798
- v1IndexIndexnameConfigPropertyPatch(xStoreid: string, xStoresecret: string, indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
9194
+ v1IndexIndexnameConfigPropertyPatch(indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
9195
+ /**
9196
+ * Search documents using store credentials with optional autocomplete suggestions
9197
+ * @summary Public Search API
9198
+ * @param {string} xStoreID Store ID
9199
+ * @param {string} xStoreSecret Store Secret
9200
+ * @param {DataTypesPublicSearchRequest} body Search request (set include_suggestions: true for autocomplete)
9201
+ * @param {*} [options] Override http request option.
9202
+ * @throws {RequiredError}
9203
+ */
9204
+ v1SearchPost(xStoreID: string, xStoreSecret: string, body: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOfficialSearchResponseWrapper>>;
8799
9205
  };
8800
9206
  /**
8801
9207
  * SearchApi - factory interface
@@ -8803,49 +9209,52 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
8803
9209
  */
8804
9210
  export declare const SearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8805
9211
  /**
8806
- * Configure the index for search
8807
- * @summary Index Config
8808
- * @param {string} xStoreid Store ID
8809
- * @param {string} xStoresecret Store Secret
8810
- * @param {DataTypesIndexConfig} body Index configuration
9212
+ * Search documents with optional configuration override and autocomplete suggestions
9213
+ * @summary Admin Search API
9214
+ * @param {string} xStoreID Store ID for the selected store
9215
+ * @param {string} xStoreSecret Store Secret for the selected store
9216
+ * @param {DataTypesAdminSearchRequest} body Admin search request (set include_suggestions: true for autocomplete)
8811
9217
  * @param {*} [options] Override http request option.
8812
9218
  * @throws {RequiredError}
8813
9219
  */
8814
- v1IndexConfigPost(xStoreid: string, xStoresecret: string, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
9220
+ adminV1SearchPost(xStoreID: string, xStoreSecret: string, body: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOfficialSearchResponseWrapper>;
8815
9221
  /**
8816
- * Update a single property of the index configuration
8817
- * @summary Update Index Config Property
8818
- * @param {string} xStoreid Store ID
8819
- * @param {string} xStoresecret Store Secret
8820
- * @param {string} property Property name
8821
- * @param {object} body Property value
9222
+ * Get the current index configuration
9223
+ * @summary Get Index Config
9224
+ * @param {string} indexname Index Name
8822
9225
  * @param {*} [options] Override http request option.
8823
9226
  * @throws {RequiredError}
8824
9227
  */
8825
- v1IndexConfigPropertyPatch(xStoreid: string, xStoresecret: string, property: string, body: object, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
9228
+ v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponse>;
8826
9229
  /**
8827
9230
  * Configure the index for search
8828
9231
  * @summary Index Config
8829
- * @param {string} xStoreid Store ID
8830
- * @param {string} xStoresecret Store Secret
8831
9232
  * @param {string} indexname Index Name
8832
9233
  * @param {DataTypesIndexConfig} body Index configuration
8833
9234
  * @param {*} [options] Override http request option.
8834
9235
  * @throws {RequiredError}
8835
9236
  */
8836
- v1IndexIndexnameConfigPost(xStoreid: string, xStoresecret: string, indexname: string, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
9237
+ v1IndexIndexnameConfigPost(indexname: string, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
8837
9238
  /**
8838
9239
  * Update a single property of the index configuration
8839
9240
  * @summary Update Index Config Property
8840
- * @param {string} xStoreid Store ID
8841
- * @param {string} xStoresecret Store Secret
8842
9241
  * @param {string} indexname Index Name
8843
9242
  * @param {string} property Property name
8844
9243
  * @param {object} body Property value
8845
9244
  * @param {*} [options] Override http request option.
8846
9245
  * @throws {RequiredError}
8847
9246
  */
8848
- v1IndexIndexnameConfigPropertyPatch(xStoreid: string, xStoresecret: string, indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
9247
+ v1IndexIndexnameConfigPropertyPatch(indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
9248
+ /**
9249
+ * Search documents using store credentials with optional autocomplete suggestions
9250
+ * @summary Public Search API
9251
+ * @param {string} xStoreID Store ID
9252
+ * @param {string} xStoreSecret Store Secret
9253
+ * @param {DataTypesPublicSearchRequest} body Search request (set include_suggestions: true for autocomplete)
9254
+ * @param {*} [options] Override http request option.
9255
+ * @throws {RequiredError}
9256
+ */
9257
+ v1SearchPost(xStoreID: string, xStoreSecret: string, body: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOfficialSearchResponseWrapper>;
8849
9258
  };
8850
9259
  /**
8851
9260
  * SearchApi - object-oriented interface
@@ -8855,45 +9264,38 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
8855
9264
  */
8856
9265
  export declare class SearchApi extends BaseAPI {
8857
9266
  /**
8858
- * Configure the index for search
8859
- * @summary Index Config
8860
- * @param {string} xStoreid Store ID
8861
- * @param {string} xStoresecret Store Secret
8862
- * @param {DataTypesIndexConfig} body Index configuration
9267
+ * Search documents with optional configuration override and autocomplete suggestions
9268
+ * @summary Admin Search API
9269
+ * @param {string} xStoreID Store ID for the selected store
9270
+ * @param {string} xStoreSecret Store Secret for the selected store
9271
+ * @param {DataTypesAdminSearchRequest} body Admin search request (set include_suggestions: true for autocomplete)
8863
9272
  * @param {*} [options] Override http request option.
8864
9273
  * @throws {RequiredError}
8865
9274
  * @memberof SearchApi
8866
9275
  */
8867
- v1IndexConfigPost(xStoreid: string, xStoresecret: string, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any>>;
9276
+ adminV1SearchPost(xStoreID: string, xStoreSecret: string, body: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOfficialSearchResponseWrapper, any>>;
8868
9277
  /**
8869
- * Update a single property of the index configuration
8870
- * @summary Update Index Config Property
8871
- * @param {string} xStoreid Store ID
8872
- * @param {string} xStoresecret Store Secret
8873
- * @param {string} property Property name
8874
- * @param {object} body Property value
9278
+ * Get the current index configuration
9279
+ * @summary Get Index Config
9280
+ * @param {string} indexname Index Name
8875
9281
  * @param {*} [options] Override http request option.
8876
9282
  * @throws {RequiredError}
8877
9283
  * @memberof SearchApi
8878
9284
  */
8879
- v1IndexConfigPropertyPatch(xStoreid: string, xStoresecret: string, property: string, body: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any>>;
9285
+ v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesIndexConfigResponse, any>>;
8880
9286
  /**
8881
9287
  * Configure the index for search
8882
9288
  * @summary Index Config
8883
- * @param {string} xStoreid Store ID
8884
- * @param {string} xStoresecret Store Secret
8885
9289
  * @param {string} indexname Index Name
8886
9290
  * @param {DataTypesIndexConfig} body Index configuration
8887
9291
  * @param {*} [options] Override http request option.
8888
9292
  * @throws {RequiredError}
8889
9293
  * @memberof SearchApi
8890
9294
  */
8891
- v1IndexIndexnameConfigPost(xStoreid: string, xStoresecret: string, indexname: string, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any>>;
9295
+ v1IndexIndexnameConfigPost(indexname: string, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any>>;
8892
9296
  /**
8893
9297
  * Update a single property of the index configuration
8894
9298
  * @summary Update Index Config Property
8895
- * @param {string} xStoreid Store ID
8896
- * @param {string} xStoresecret Store Secret
8897
9299
  * @param {string} indexname Index Name
8898
9300
  * @param {string} property Property name
8899
9301
  * @param {object} body Property value
@@ -8901,7 +9303,18 @@ export declare class SearchApi extends BaseAPI {
8901
9303
  * @throws {RequiredError}
8902
9304
  * @memberof SearchApi
8903
9305
  */
8904
- v1IndexIndexnameConfigPropertyPatch(xStoreid: string, xStoresecret: string, indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any>>;
9306
+ v1IndexIndexnameConfigPropertyPatch(indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any>>;
9307
+ /**
9308
+ * Search documents using store credentials with optional autocomplete suggestions
9309
+ * @summary Public Search API
9310
+ * @param {string} xStoreID Store ID
9311
+ * @param {string} xStoreSecret Store Secret
9312
+ * @param {DataTypesPublicSearchRequest} body Search request (set include_suggestions: true for autocomplete)
9313
+ * @param {*} [options] Override http request option.
9314
+ * @throws {RequiredError}
9315
+ * @memberof SearchApi
9316
+ */
9317
+ v1SearchPost(xStoreID: string, xStoreSecret: string, body: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOfficialSearchResponseWrapper, any>>;
8905
9318
  }
8906
9319
  /**
8907
9320
  * StoresApi - axios parameter creator