@seekora-ai/admin-api 1.0.25 → 1.0.26

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 CHANGED
@@ -1,4 +1,4 @@
1
- ## @seekora-ai/admin-api@1.0.25
1
+ ## @seekora-ai/admin-api@1.0.26
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @seekora-ai/admin-api@1.0.25 --save
39
+ npm install @seekora-ai/admin-api@1.0.26 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -188,7 +188,7 @@ Class | Method | HTTP request | Description
188
188
  *StoresApi* | [**adminStoresStoreIDPut**](docs/StoresApi.md#adminstoresstoreidput) | **PUT** /admin/Stores/{storeID} | Update an existing store
189
189
  *StoresApi* | [**adminStoresUpdateStatusIdStatusPut**](docs/StoresApi.md#adminstoresupdatestatusidstatusput) | **PUT** /admin/Stores/UpdateStatus/{id}/{status} | Update an existing StoreStatus
190
190
  *StoresApi* | [**adminStoresXStoreIDConfigGet**](docs/StoresApi.md#adminstoresxstoreidconfigget) | **GET** /admin/Stores/{xStoreID}/config | Get Store Config
191
- *StoresApi* | [**adminStoresXStoreIDConfigPut**](docs/StoresApi.md#adminstoresxstoreidconfigput) | **PUT** /admin/Stores/{xStoreID}/config | Update Store Config
191
+ *StoresApi* | [**adminStoresXStoreIDConfigPut**](docs/StoresApi.md#adminstoresxstoreidconfigput) | **PUT** /admin/Stores/{xStoreID}/config | Update Store Config (Partial)
192
192
  *StoresApi* | [**adminStoresXStoreIDConfigSchemaGet**](docs/StoresApi.md#adminstoresxstoreidconfigschemaget) | **GET** /admin/Stores/{xStoreID}/config-schema | Get Store Config Schema
193
193
  *StoresApi* | [**adminStoresXStoreIDDefaultsGet**](docs/StoresApi.md#adminstoresxstoreiddefaultsget) | **GET** /admin/Stores/{xStoreID}/defaults | Get Store Schema-Based Defaults
194
194
  *SubscriptionsApi* | [**adminSubscriptionsSubscriptionIDPut**](docs/SubscriptionsApi.md#adminsubscriptionssubscriptionidput) | **PUT** /admin/subscriptions/{subscriptionID} | Update an existing Subscription
@@ -336,6 +336,7 @@ Class | Method | HTTP request | Description
336
336
  - [DataTypesSortField](docs/DataTypesSortField.md)
337
337
  - [DataTypesSource](docs/DataTypesSource.md)
338
338
  - [DataTypesSourcesListResponse](docs/DataTypesSourcesListResponse.md)
339
+ - [DataTypesStopwordEntry](docs/DataTypesStopwordEntry.md)
339
340
  - [DataTypesStore](docs/DataTypesStore.md)
340
341
  - [DataTypesStoreKeyResponse](docs/DataTypesStoreKeyResponse.md)
341
342
  - [DataTypesStoreKeyResponseWrapper](docs/DataTypesStoreKeyResponseWrapper.md)
@@ -346,6 +347,7 @@ Class | Method | HTTP request | Description
346
347
  - [DataTypesSubscription](docs/DataTypesSubscription.md)
347
348
  - [DataTypesSubscriptionResponse](docs/DataTypesSubscriptionResponse.md)
348
349
  - [DataTypesSubscriptionsListResponse](docs/DataTypesSubscriptionsListResponse.md)
350
+ - [DataTypesSynonymEntry](docs/DataTypesSynonymEntry.md)
349
351
  - [DataTypesTask](docs/DataTypesTask.md)
350
352
  - [DataTypesTaskRun](docs/DataTypesTaskRun.md)
351
353
  - [DataTypesTriggerTaskRunResponse](docs/DataTypesTriggerTaskRunResponse.md)
package/api.ts CHANGED
@@ -415,12 +415,24 @@ export interface DataTypesAdminSearchRequest {
415
415
  * @memberof DataTypesAdminSearchRequest
416
416
  */
417
417
  'sort'?: string;
418
+ /**
419
+ * IDs of stopword sets to use
420
+ * @type {Array<string>}
421
+ * @memberof DataTypesAdminSearchRequest
422
+ */
423
+ 'stopword_sets'?: Array<string>;
418
424
  /**
419
425
  *
420
426
  * @type {number}
421
427
  * @memberof DataTypesAdminSearchRequest
422
428
  */
423
429
  'suggestions_limit'?: number;
430
+ /**
431
+ * IDs of synonym sets to use
432
+ * @type {Array<string>}
433
+ * @memberof DataTypesAdminSearchRequest
434
+ */
435
+ 'synonym_sets'?: Array<string>;
424
436
  }
425
437
  /**
426
438
  *
@@ -2179,6 +2191,18 @@ export interface DataTypesIndexConfig {
2179
2191
  * @memberof DataTypesIndexConfig
2180
2192
  */
2181
2193
  'collection_name'?: string;
2194
+ /**
2195
+ *
2196
+ * @type {string}
2197
+ * @memberof DataTypesIndexConfig
2198
+ */
2199
+ 'default_sorting_field'?: string;
2200
+ /**
2201
+ * Default stopwords set ID to use in searches
2202
+ * @type {string}
2203
+ * @memberof DataTypesIndexConfig
2204
+ */
2205
+ 'default_stopwords_set'?: string;
2182
2206
  /**
2183
2207
  *
2184
2208
  * @type {number}
@@ -2443,12 +2467,36 @@ export interface DataTypesIndexConfig {
2443
2467
  * @memberof DataTypesIndexConfig
2444
2468
  */
2445
2469
  'sort_by'?: Array<DataTypesSortField>;
2470
+ /**
2471
+ * Flattened stopwords and synonyms fields
2472
+ * @type {Array<DataTypesStopwordEntry>}
2473
+ * @memberof DataTypesIndexConfig
2474
+ */
2475
+ 'stopwords'?: Array<DataTypesStopwordEntry>;
2476
+ /**
2477
+ *
2478
+ * @type {Array<string>}
2479
+ * @memberof DataTypesIndexConfig
2480
+ */
2481
+ 'symbols_to_index'?: Array<string>;
2482
+ /**
2483
+ *
2484
+ * @type {Array<DataTypesSynonymEntry>}
2485
+ * @memberof DataTypesIndexConfig
2486
+ */
2487
+ 'synonyms'?: Array<DataTypesSynonymEntry>;
2446
2488
  /**
2447
2489
  * Optional: Search-only scoped API key
2448
2490
  * @type {string}
2449
2491
  * @memberof DataTypesIndexConfig
2450
2492
  */
2451
2493
  'token'?: string;
2494
+ /**
2495
+ *
2496
+ * @type {Array<string>}
2497
+ * @memberof DataTypesIndexConfig
2498
+ */
2499
+ 'token_separators'?: Array<string>;
2452
2500
  /**
2453
2501
  *
2454
2502
  * @type {boolean}
@@ -4429,12 +4477,24 @@ export interface DataTypesPublicSearchRequest {
4429
4477
  * @memberof DataTypesPublicSearchRequest
4430
4478
  */
4431
4479
  'sort'?: string;
4480
+ /**
4481
+ * IDs of stopword sets to use
4482
+ * @type {Array<string>}
4483
+ * @memberof DataTypesPublicSearchRequest
4484
+ */
4485
+ 'stopword_sets'?: Array<string>;
4432
4486
  /**
4433
4487
  *
4434
4488
  * @type {number}
4435
4489
  * @memberof DataTypesPublicSearchRequest
4436
4490
  */
4437
4491
  'suggestions_limit'?: number;
4492
+ /**
4493
+ * IDs of synonym sets to use
4494
+ * @type {Array<string>}
4495
+ * @memberof DataTypesPublicSearchRequest
4496
+ */
4497
+ 'synonym_sets'?: Array<string>;
4438
4498
  }
4439
4499
  /**
4440
4500
  *
@@ -5421,6 +5481,31 @@ export interface DataTypesSourcesListResponse {
5421
5481
  */
5422
5482
  'status'?: number;
5423
5483
  }
5484
+ /**
5485
+ *
5486
+ * @export
5487
+ * @interface DataTypesStopwordEntry
5488
+ */
5489
+ export interface DataTypesStopwordEntry {
5490
+ /**
5491
+ * Stopword set ID
5492
+ * @type {string}
5493
+ * @memberof DataTypesStopwordEntry
5494
+ */
5495
+ 'id'?: string;
5496
+ /**
5497
+ * Optional locale
5498
+ * @type {string}
5499
+ * @memberof DataTypesStopwordEntry
5500
+ */
5501
+ 'locale'?: string;
5502
+ /**
5503
+ * Array of stopwords
5504
+ * @type {Array<string>}
5505
+ * @memberof DataTypesStopwordEntry
5506
+ */
5507
+ 'stopwords'?: Array<string>;
5508
+ }
5424
5509
  /**
5425
5510
  *
5426
5511
  * @export
@@ -5851,6 +5936,37 @@ export interface DataTypesSubscriptionsListResponse {
5851
5936
  */
5852
5937
  'status'?: number;
5853
5938
  }
5939
+ /**
5940
+ *
5941
+ * @export
5942
+ * @interface DataTypesSynonymEntry
5943
+ */
5944
+ export interface DataTypesSynonymEntry {
5945
+ /**
5946
+ * Synonym set ID
5947
+ * @type {string}
5948
+ * @memberof DataTypesSynonymEntry
5949
+ */
5950
+ 'id'?: string;
5951
+ /**
5952
+ * Optional locale
5953
+ * @type {string}
5954
+ * @memberof DataTypesSynonymEntry
5955
+ */
5956
+ 'locale'?: string;
5957
+ /**
5958
+ * Optional root word
5959
+ * @type {string}
5960
+ * @memberof DataTypesSynonymEntry
5961
+ */
5962
+ 'root'?: string;
5963
+ /**
5964
+ * Array of synonyms
5965
+ * @type {Array<string>}
5966
+ * @memberof DataTypesSynonymEntry
5967
+ */
5968
+ 'synonyms'?: Array<string>;
5969
+ }
5854
5970
  /**
5855
5971
  *
5856
5972
  * @export
@@ -16729,10 +16845,10 @@ export class RolesApi extends BaseAPI {
16729
16845
  export const SearchApiAxiosParamCreator = function (configuration?: Configuration) {
16730
16846
  return {
16731
16847
  /**
16732
- * Search documents with optional configuration override and autocomplete suggestions
16848
+ * Search documents with optional configuration override, autocomplete suggestions, and configurable stopwords/synonyms
16733
16849
  * @summary Admin Search API
16734
16850
  * @param {string} xStoreID X-Store ID
16735
- * @param {DataTypesAdminSearchRequest} body Admin search request (set include_suggestions: true for autocomplete)
16851
+ * @param {DataTypesAdminSearchRequest} body Admin search request with optional stopword_sets and synonym_sets for granular control
16736
16852
  * @param {*} [options] Override http request option.
16737
16853
  * @throws {RequiredError}
16738
16854
  */
@@ -16959,11 +17075,11 @@ export const SearchApiAxiosParamCreator = function (configuration?: Configuratio
16959
17075
  };
16960
17076
  },
16961
17077
  /**
16962
- * Search documents using store credentials with optional autocomplete suggestions
17078
+ * Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms
16963
17079
  * @summary Public Search API
16964
17080
  * @param {string} xStoreid Store ID
16965
17081
  * @param {string} xStoresecret Store Secret
16966
- * @param {DataTypesPublicSearchRequest} body Search request (set include_suggestions: true for autocomplete)
17082
+ * @param {DataTypesPublicSearchRequest} body Search request with optional stopword_sets and synonym_sets for granular control
16967
17083
  * @param {*} [options] Override http request option.
16968
17084
  * @throws {RequiredError}
16969
17085
  */
@@ -17017,10 +17133,10 @@ export const SearchApiFp = function(configuration?: Configuration) {
17017
17133
  const localVarAxiosParamCreator = SearchApiAxiosParamCreator(configuration)
17018
17134
  return {
17019
17135
  /**
17020
- * Search documents with optional configuration override and autocomplete suggestions
17136
+ * Search documents with optional configuration override, autocomplete suggestions, and configurable stopwords/synonyms
17021
17137
  * @summary Admin Search API
17022
17138
  * @param {string} xStoreID X-Store ID
17023
- * @param {DataTypesAdminSearchRequest} body Admin search request (set include_suggestions: true for autocomplete)
17139
+ * @param {DataTypesAdminSearchRequest} body Admin search request with optional stopword_sets and synonym_sets for granular control
17024
17140
  * @param {*} [options] Override http request option.
17025
17141
  * @throws {RequiredError}
17026
17142
  */
@@ -17099,11 +17215,11 @@ export const SearchApiFp = function(configuration?: Configuration) {
17099
17215
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
17100
17216
  },
17101
17217
  /**
17102
- * Search documents using store credentials with optional autocomplete suggestions
17218
+ * Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms
17103
17219
  * @summary Public Search API
17104
17220
  * @param {string} xStoreid Store ID
17105
17221
  * @param {string} xStoresecret Store Secret
17106
- * @param {DataTypesPublicSearchRequest} body Search request (set include_suggestions: true for autocomplete)
17222
+ * @param {DataTypesPublicSearchRequest} body Search request with optional stopword_sets and synonym_sets for granular control
17107
17223
  * @param {*} [options] Override http request option.
17108
17224
  * @throws {RequiredError}
17109
17225
  */
@@ -17124,10 +17240,10 @@ export const SearchApiFactory = function (configuration?: Configuration, basePat
17124
17240
  const localVarFp = SearchApiFp(configuration)
17125
17241
  return {
17126
17242
  /**
17127
- * Search documents with optional configuration override and autocomplete suggestions
17243
+ * Search documents with optional configuration override, autocomplete suggestions, and configurable stopwords/synonyms
17128
17244
  * @summary Admin Search API
17129
17245
  * @param {string} xStoreID X-Store ID
17130
- * @param {DataTypesAdminSearchRequest} body Admin search request (set include_suggestions: true for autocomplete)
17246
+ * @param {DataTypesAdminSearchRequest} body Admin search request with optional stopword_sets and synonym_sets for granular control
17131
17247
  * @param {*} [options] Override http request option.
17132
17248
  * @throws {RequiredError}
17133
17249
  */
@@ -17188,11 +17304,11 @@ export const SearchApiFactory = function (configuration?: Configuration, basePat
17188
17304
  return localVarFp.v1IndexIndexnameDefaultsGet(indexname, options).then((request) => request(axios, basePath));
17189
17305
  },
17190
17306
  /**
17191
- * Search documents using store credentials with optional autocomplete suggestions
17307
+ * Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms
17192
17308
  * @summary Public Search API
17193
17309
  * @param {string} xStoreid Store ID
17194
17310
  * @param {string} xStoresecret Store Secret
17195
- * @param {DataTypesPublicSearchRequest} body Search request (set include_suggestions: true for autocomplete)
17311
+ * @param {DataTypesPublicSearchRequest} body Search request with optional stopword_sets and synonym_sets for granular control
17196
17312
  * @param {*} [options] Override http request option.
17197
17313
  * @throws {RequiredError}
17198
17314
  */
@@ -17210,10 +17326,10 @@ export const SearchApiFactory = function (configuration?: Configuration, basePat
17210
17326
  */
17211
17327
  export class SearchApi extends BaseAPI {
17212
17328
  /**
17213
- * Search documents with optional configuration override and autocomplete suggestions
17329
+ * Search documents with optional configuration override, autocomplete suggestions, and configurable stopwords/synonyms
17214
17330
  * @summary Admin Search API
17215
17331
  * @param {string} xStoreID X-Store ID
17216
- * @param {DataTypesAdminSearchRequest} body Admin search request (set include_suggestions: true for autocomplete)
17332
+ * @param {DataTypesAdminSearchRequest} body Admin search request with optional stopword_sets and synonym_sets for granular control
17217
17333
  * @param {*} [options] Override http request option.
17218
17334
  * @throws {RequiredError}
17219
17335
  * @memberof SearchApi
@@ -17286,11 +17402,11 @@ export class SearchApi extends BaseAPI {
17286
17402
  }
17287
17403
 
17288
17404
  /**
17289
- * Search documents using store credentials with optional autocomplete suggestions
17405
+ * Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms
17290
17406
  * @summary Public Search API
17291
17407
  * @param {string} xStoreid Store ID
17292
17408
  * @param {string} xStoresecret Store Secret
17293
- * @param {DataTypesPublicSearchRequest} body Search request (set include_suggestions: true for autocomplete)
17409
+ * @param {DataTypesPublicSearchRequest} body Search request with optional stopword_sets and synonym_sets for granular control
17294
17410
  * @param {*} [options] Override http request option.
17295
17411
  * @throws {RequiredError}
17296
17412
  * @memberof SearchApi
@@ -17539,10 +17655,10 @@ export const StoresApiAxiosParamCreator = function (configuration?: Configuratio
17539
17655
  };
17540
17656
  },
17541
17657
  /**
17542
- * Updates the store configuration using x-store ID
17543
- * @summary Update Store Config
17658
+ * Updates the store configuration using x-store ID. Supports partial updates - you can update individual fields without providing all required fields. Now supports stopwords and synonyms configuration for enhanced search capabilities.
17659
+ * @summary Update Store Config (Partial)
17544
17660
  * @param {string} xStoreID X-Store ID
17545
- * @param {DataTypesIndexConfig} body Store configuration
17661
+ * @param {DataTypesIndexConfig} body Store configuration (partial updates supported) including stopwords and synonyms
17546
17662
  * @param {*} [options] Override http request option.
17547
17663
  * @throws {RequiredError}
17548
17664
  */
@@ -17745,10 +17861,10 @@ export const StoresApiFp = function(configuration?: Configuration) {
17745
17861
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
17746
17862
  },
17747
17863
  /**
17748
- * Updates the store configuration using x-store ID
17749
- * @summary Update Store Config
17864
+ * Updates the store configuration using x-store ID. Supports partial updates - you can update individual fields without providing all required fields. Now supports stopwords and synonyms configuration for enhanced search capabilities.
17865
+ * @summary Update Store Config (Partial)
17750
17866
  * @param {string} xStoreID X-Store ID
17751
- * @param {DataTypesIndexConfig} body Store configuration
17867
+ * @param {DataTypesIndexConfig} body Store configuration (partial updates supported) including stopwords and synonyms
17752
17868
  * @param {*} [options] Override http request option.
17753
17869
  * @throws {RequiredError}
17754
17870
  */
@@ -17856,10 +17972,10 @@ export const StoresApiFactory = function (configuration?: Configuration, basePat
17856
17972
  return localVarFp.adminStoresXStoreIDConfigGet(xStoreID, options).then((request) => request(axios, basePath));
17857
17973
  },
17858
17974
  /**
17859
- * Updates the store configuration using x-store ID
17860
- * @summary Update Store Config
17975
+ * Updates the store configuration using x-store ID. Supports partial updates - you can update individual fields without providing all required fields. Now supports stopwords and synonyms configuration for enhanced search capabilities.
17976
+ * @summary Update Store Config (Partial)
17861
17977
  * @param {string} xStoreID X-Store ID
17862
- * @param {DataTypesIndexConfig} body Store configuration
17978
+ * @param {DataTypesIndexConfig} body Store configuration (partial updates supported) including stopwords and synonyms
17863
17979
  * @param {*} [options] Override http request option.
17864
17980
  * @throws {RequiredError}
17865
17981
  */
@@ -17970,10 +18086,10 @@ export class StoresApi extends BaseAPI {
17970
18086
  }
17971
18087
 
17972
18088
  /**
17973
- * Updates the store configuration using x-store ID
17974
- * @summary Update Store Config
18089
+ * Updates the store configuration using x-store ID. Supports partial updates - you can update individual fields without providing all required fields. Now supports stopwords and synonyms configuration for enhanced search capabilities.
18090
+ * @summary Update Store Config (Partial)
17975
18091
  * @param {string} xStoreID X-Store ID
17976
- * @param {DataTypesIndexConfig} body Store configuration
18092
+ * @param {DataTypesIndexConfig} body Store configuration (partial updates supported) including stopwords and synonyms
17977
18093
  * @param {*} [options] Override http request option.
17978
18094
  * @throws {RequiredError}
17979
18095
  * @memberof StoresApi