@seekora-ai/admin-api 1.1.86 → 1.1.87

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
@@ -61955,212 +61955,6 @@ export declare class RolesApi extends BaseAPI {
61955
61955
  */
61956
61956
  adminRolesRoleIdPermissionsPut(roleId: number, dataTypesSlimUpdateRolePermissionsRequest: DataTypesSlimUpdateRolePermissionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
61957
61957
  }
61958
- /**
61959
- * SDKDocumentsApi - axios parameter creator
61960
- * @export
61961
- */
61962
- export declare const SDKDocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
61963
- /**
61964
- * Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. Each item can specify its own action.
61965
- * @summary Bulk index documents
61966
- * @param {string} xStoreid Store ID (from dashboard)
61967
- * @param {string} xStoreWriteSecret Store write secret
61968
- * @param {string} xStoreID Store ID (must match x-storeid header)
61969
- * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
61970
- * @param {*} [options] Override http request option.
61971
- * @throws {RequiredError}
61972
- */
61973
- apiV1StoresXStoreIDDocumentsBulkPost: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
61974
- /**
61975
- * Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
61976
- * @summary Delete a document
61977
- * @param {string} xStoreid Store ID (from dashboard)
61978
- * @param {string} xStoreWriteSecret Store write secret
61979
- * @param {string} xStoreID Store ID (must match x-storeid header)
61980
- * @param {string} documentID Document ID to delete
61981
- * @param {*} [options] Override http request option.
61982
- * @throws {RequiredError}
61983
- */
61984
- apiV1StoresXStoreIDDocumentsDocumentIDDelete: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
61985
- /**
61986
- * Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret` (read secret). Path `xStoreID` must match the `x-storeid` header. Used by product pages and PDP.
61987
- * @summary Get a document by ID
61988
- * @param {string} xStoreid Store ID (from dashboard)
61989
- * @param {string} xStoresecret Store read secret
61990
- * @param {string} xStoreID Store ID (must match x-storeid header)
61991
- * @param {string} documentID Document ID to retrieve
61992
- * @param {*} [options] Override http request option.
61993
- * @throws {RequiredError}
61994
- */
61995
- apiV1StoresXStoreIDDocumentsDocumentIDGet: (xStoreid: string, xStoresecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
61996
- /**
61997
- * Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
61998
- * @summary Index a single document
61999
- * @param {string} xStoreid Store ID (from dashboard)
62000
- * @param {string} xStoreWriteSecret Store write secret
62001
- * @param {string} xStoreID Store ID (must match x-storeid header)
62002
- * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
62003
- * @param {*} [options] Override http request option.
62004
- * @throws {RequiredError}
62005
- */
62006
- apiV1StoresXStoreIDDocumentsPost: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62007
- };
62008
- /**
62009
- * SDKDocumentsApi - functional programming interface
62010
- * @export
62011
- */
62012
- export declare const SDKDocumentsApiFp: (configuration?: Configuration) => {
62013
- /**
62014
- * Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. Each item can specify its own action.
62015
- * @summary Bulk index documents
62016
- * @param {string} xStoreid Store ID (from dashboard)
62017
- * @param {string} xStoreWriteSecret Store write secret
62018
- * @param {string} xStoreID Store ID (must match x-storeid header)
62019
- * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
62020
- * @param {*} [options] Override http request option.
62021
- * @throws {RequiredError}
62022
- */
62023
- apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesBulkDocumentResponseWrapper>>;
62024
- /**
62025
- * Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
62026
- * @summary Delete a document
62027
- * @param {string} xStoreid Store ID (from dashboard)
62028
- * @param {string} xStoreWriteSecret Store write secret
62029
- * @param {string} xStoreID Store ID (must match x-storeid header)
62030
- * @param {string} documentID Document ID to delete
62031
- * @param {*} [options] Override http request option.
62032
- * @throws {RequiredError}
62033
- */
62034
- apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
62035
- /**
62036
- * Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret` (read secret). Path `xStoreID` must match the `x-storeid` header. Used by product pages and PDP.
62037
- * @summary Get a document by ID
62038
- * @param {string} xStoreid Store ID (from dashboard)
62039
- * @param {string} xStoresecret Store read secret
62040
- * @param {string} xStoreID Store ID (must match x-storeid header)
62041
- * @param {string} documentID Document ID to retrieve
62042
- * @param {*} [options] Override http request option.
62043
- * @throws {RequiredError}
62044
- */
62045
- apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
62046
- /**
62047
- * Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
62048
- * @summary Index a single document
62049
- * @param {string} xStoreid Store ID (from dashboard)
62050
- * @param {string} xStoreWriteSecret Store write secret
62051
- * @param {string} xStoreID Store ID (must match x-storeid header)
62052
- * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
62053
- * @param {*} [options] Override http request option.
62054
- * @throws {RequiredError}
62055
- */
62056
- apiV1StoresXStoreIDDocumentsPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
62057
- };
62058
- /**
62059
- * SDKDocumentsApi - factory interface
62060
- * @export
62061
- */
62062
- export declare const SDKDocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
62063
- /**
62064
- * Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. Each item can specify its own action.
62065
- * @summary Bulk index documents
62066
- * @param {string} xStoreid Store ID (from dashboard)
62067
- * @param {string} xStoreWriteSecret Store write secret
62068
- * @param {string} xStoreID Store ID (must match x-storeid header)
62069
- * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
62070
- * @param {*} [options] Override http request option.
62071
- * @throws {RequiredError}
62072
- */
62073
- apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesBulkDocumentResponseWrapper>;
62074
- /**
62075
- * Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
62076
- * @summary Delete a document
62077
- * @param {string} xStoreid Store ID (from dashboard)
62078
- * @param {string} xStoreWriteSecret Store write secret
62079
- * @param {string} xStoreID Store ID (must match x-storeid header)
62080
- * @param {string} documentID Document ID to delete
62081
- * @param {*} [options] Override http request option.
62082
- * @throws {RequiredError}
62083
- */
62084
- apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
62085
- /**
62086
- * Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret` (read secret). Path `xStoreID` must match the `x-storeid` header. Used by product pages and PDP.
62087
- * @summary Get a document by ID
62088
- * @param {string} xStoreid Store ID (from dashboard)
62089
- * @param {string} xStoresecret Store read secret
62090
- * @param {string} xStoreID Store ID (must match x-storeid header)
62091
- * @param {string} documentID Document ID to retrieve
62092
- * @param {*} [options] Override http request option.
62093
- * @throws {RequiredError}
62094
- */
62095
- apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
62096
- /**
62097
- * Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
62098
- * @summary Index a single document
62099
- * @param {string} xStoreid Store ID (from dashboard)
62100
- * @param {string} xStoreWriteSecret Store write secret
62101
- * @param {string} xStoreID Store ID (must match x-storeid header)
62102
- * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
62103
- * @param {*} [options] Override http request option.
62104
- * @throws {RequiredError}
62105
- */
62106
- apiV1StoresXStoreIDDocumentsPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
62107
- };
62108
- /**
62109
- * SDKDocumentsApi - object-oriented interface
62110
- * @export
62111
- * @class SDKDocumentsApi
62112
- * @extends {BaseAPI}
62113
- */
62114
- export declare class SDKDocumentsApi extends BaseAPI {
62115
- /**
62116
- * Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. Each item can specify its own action.
62117
- * @summary Bulk index documents
62118
- * @param {string} xStoreid Store ID (from dashboard)
62119
- * @param {string} xStoreWriteSecret Store write secret
62120
- * @param {string} xStoreID Store ID (must match x-storeid header)
62121
- * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
62122
- * @param {*} [options] Override http request option.
62123
- * @throws {RequiredError}
62124
- * @memberof SDKDocumentsApi
62125
- */
62126
- apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesBulkDocumentResponseWrapper, any, {}>>;
62127
- /**
62128
- * Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
62129
- * @summary Delete a document
62130
- * @param {string} xStoreid Store ID (from dashboard)
62131
- * @param {string} xStoreWriteSecret Store write secret
62132
- * @param {string} xStoreID Store ID (must match x-storeid header)
62133
- * @param {string} documentID Document ID to delete
62134
- * @param {*} [options] Override http request option.
62135
- * @throws {RequiredError}
62136
- * @memberof SDKDocumentsApi
62137
- */
62138
- apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
62139
- /**
62140
- * Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret` (read secret). Path `xStoreID` must match the `x-storeid` header. Used by product pages and PDP.
62141
- * @summary Get a document by ID
62142
- * @param {string} xStoreid Store ID (from dashboard)
62143
- * @param {string} xStoresecret Store read secret
62144
- * @param {string} xStoreID Store ID (must match x-storeid header)
62145
- * @param {string} documentID Document ID to retrieve
62146
- * @param {*} [options] Override http request option.
62147
- * @throws {RequiredError}
62148
- * @memberof SDKDocumentsApi
62149
- */
62150
- apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
62151
- /**
62152
- * Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
62153
- * @summary Index a single document
62154
- * @param {string} xStoreid Store ID (from dashboard)
62155
- * @param {string} xStoreWriteSecret Store write secret
62156
- * @param {string} xStoreID Store ID (must match x-storeid header)
62157
- * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
62158
- * @param {*} [options] Override http request option.
62159
- * @throws {RequiredError}
62160
- * @memberof SDKDocumentsApi
62161
- */
62162
- apiV1StoresXStoreIDDocumentsPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
62163
- }
62164
61958
  /**
62165
61959
  * SDKExperimentsApi - axios parameter creator
62166
61960
  * @export
@@ -62233,2032 +62027,2108 @@ export declare class SDKExperimentsApi extends BaseAPI {
62233
62027
  v1ExperimentsAssignmentGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesExperimentAssignmentResponse, any, {}>>;
62234
62028
  }
62235
62029
  /**
62236
- * SDKQuerySuggestionsConfigApi - axios parameter creator
62030
+ * SearchApi - axios parameter creator
62237
62031
  * @export
62238
62032
  */
62239
- export declare const SDKQuerySuggestionsConfigApiAxiosParamCreator: (configuration?: Configuration) => {
62033
+ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration) => {
62240
62034
  /**
62241
- * Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
62242
- * @summary Get query suggestions configuration
62243
- * @param {string} xStoreid Store ID (from dashboard)
62244
- * @param {string} xStoresecret Store read secret
62245
- * @param {string} xStoreID Store ID (must match x-storeid header)
62035
+ * Search documents with combined widget and document data, autocomplete suggestions, and configurable stopwords/synonyms
62036
+ * @summary Admin Search API
62037
+ * @param {string} xStoreID X-Store ID
62038
+ * @param {DataTypesAdminSearchRequest} dataTypesAdminSearchRequest Admin search request with optional stopword_sets and synonym_sets for granular control
62246
62039
  * @param {*} [options] Override http request option.
62247
62040
  * @throws {RequiredError}
62248
62041
  */
62249
- apiV1StoresXStoreIDQuerySuggestionsConfigGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62042
+ adminV1SearchXStoreIDPost: (xStoreID: string, dataTypesAdminSearchRequest: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62250
62043
  /**
62251
- * Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
62252
- * @summary Update query suggestions configuration
62253
- * @param {string} xStoreid Store ID (from dashboard)
62254
- * @param {string} xStoreWriteSecret Store write secret
62255
- * @param {string} xStoreID Store ID (must match x-storeid header)
62256
- * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
62044
+ * Get metadata about all configurable fields for dynamic form generation
62045
+ * @summary Get Configuration Schema
62046
+ * @param {string} [indexname] Index name to get field options from
62257
62047
  * @param {*} [options] Override http request option.
62258
62048
  * @throws {RequiredError}
62259
62049
  */
62260
- apiV1StoresXStoreIDQuerySuggestionsConfigPut: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62261
- };
62262
- /**
62263
- * SDKQuerySuggestionsConfigApi - functional programming interface
62264
- * @export
62265
- */
62266
- export declare const SDKQuerySuggestionsConfigApiFp: (configuration?: Configuration) => {
62050
+ v1IndexConfigSchemaGet: (indexname?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62267
62051
  /**
62268
- * Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
62269
- * @summary Get query suggestions configuration
62270
- * @param {string} xStoreid Store ID (from dashboard)
62271
- * @param {string} xStoresecret Store read secret
62272
- * @param {string} xStoreID Store ID (must match x-storeid header)
62052
+ * Get the current index configuration
62053
+ * @summary Get Index Config
62054
+ * @param {string} indexname Index Name
62273
62055
  * @param {*} [options] Override http request option.
62274
62056
  * @throws {RequiredError}
62275
62057
  */
62276
- apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>>;
62058
+ v1IndexIndexnameConfigGet: (indexname: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62277
62059
  /**
62278
- * Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
62279
- * @summary Update query suggestions configuration
62280
- * @param {string} xStoreid Store ID (from dashboard)
62281
- * @param {string} xStoreWriteSecret Store write secret
62282
- * @param {string} xStoreID Store ID (must match x-storeid header)
62283
- * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
62060
+ * Configure the index for search
62061
+ * @summary Index Config
62062
+ * @param {string} indexname Index Name
62063
+ * @param {DataTypesIndexConfig} dataTypesIndexConfig Index configuration
62284
62064
  * @param {*} [options] Override http request option.
62285
62065
  * @throws {RequiredError}
62286
62066
  */
62287
- apiV1StoresXStoreIDQuerySuggestionsConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>>;
62288
- };
62289
- /**
62290
- * SDKQuerySuggestionsConfigApi - factory interface
62291
- * @export
62292
- */
62293
- export declare const SDKQuerySuggestionsConfigApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
62067
+ v1IndexIndexnameConfigPost: (indexname: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62294
62068
  /**
62295
- * Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
62296
- * @summary Get query suggestions configuration
62297
- * @param {string} xStoreid Store ID (from dashboard)
62298
- * @param {string} xStoresecret Store read secret
62299
- * @param {string} xStoreID Store ID (must match x-storeid header)
62300
- * @param {*} [options] Override http request option.
62301
- * @throws {RequiredError}
62302
- */
62303
- apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>;
62069
+ * Update a single property of the index configuration
62070
+ * @summary Update Index Config Property
62071
+ * @param {string} indexname Index Name
62072
+ * @param {string} property Property name
62073
+ * @param {object} body Property value
62074
+ * @param {*} [options] Override http request option.
62075
+ * @throws {RequiredError}
62076
+ */
62077
+ v1IndexIndexnameConfigPropertyPatch: (indexname: string, property: string, body: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62304
62078
  /**
62305
- * Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
62306
- * @summary Update query suggestions configuration
62307
- * @param {string} xStoreid Store ID (from dashboard)
62308
- * @param {string} xStoreWriteSecret Store write secret
62309
- * @param {string} xStoreID Store ID (must match x-storeid header)
62310
- * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
62079
+ * Get default configuration values computed from the Typesense schema
62080
+ * @summary Get Schema-Based Defaults
62081
+ * @param {string} indexname Index Name
62311
62082
  * @param {*} [options] Override http request option.
62312
62083
  * @throws {RequiredError}
62313
62084
  */
62314
- apiV1StoresXStoreIDQuerySuggestionsConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>;
62315
- };
62316
- /**
62317
- * SDKQuerySuggestionsConfigApi - object-oriented interface
62318
- * @export
62319
- * @class SDKQuerySuggestionsConfigApi
62320
- * @extends {BaseAPI}
62321
- */
62322
- export declare class SDKQuerySuggestionsConfigApi extends BaseAPI {
62085
+ v1IndexIndexnameDefaultsGet: (indexname: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62323
62086
  /**
62324
- * Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
62325
- * @summary Get query suggestions configuration
62087
+ * 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.
62088
+ * @summary Search (GET)
62326
62089
  * @param {string} xStoreid Store ID (from dashboard)
62327
- * @param {string} xStoresecret Store read secret
62328
- * @param {string} xStoreID Store ID (must match x-storeid header)
62090
+ * @param {string} xStoresecret Store read secret (from dashboard)
62091
+ * @param {string} q Search query
62092
+ * @param {string} [xUserId] User ID for personalization
62093
+ * @param {string} [xAnonId] Anonymous user ID for personalization
62094
+ * @param {string} [xSessionId] Session ID for personalization
62095
+ * @param {number} [page] Page number (default: 1)
62096
+ * @param {number} [perPage] Items per page (default: 10)
62097
+ * @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
62098
+ * @param {string} [filterBy] Filter string (e.g., category:shirts)
62099
+ * @param {string} [facetBy] Facet fields (comma-separated)
62100
+ * @param {number} [maxFacetValues] Maximum facet values to return
62101
+ * @param {boolean} [widgetMode] Return widget-formatted results
62102
+ * @param {boolean} [includeSuggestions] Include autocomplete suggestions
62103
+ * @param {number} [suggestionsLimit] Number of suggestions to return
62104
+ * @param {string} [analyticsTags] Analytics tags (comma-separated)
62105
+ * @param {string} [stopwordSets] Stopword set IDs (comma-separated)
62106
+ * @param {string} [synonymSets] Synonym set IDs (comma-separated)
62107
+ * @param {string} [searchFields] Fields to search in (comma-separated)
62108
+ * @param {string} [returnFields] Fields to return (comma-separated)
62109
+ * @param {string} [omitFields] Fields to omit (comma-separated)
62110
+ * @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
62111
+ * @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
62112
+ * @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
62113
+ * @param {string} [groupField] Field to group results by
62114
+ * @param {number} [groupSize] Number of results per group
62115
+ * @param {string} [snippetPrefix] Prefix for highlighted snippets
62116
+ * @param {string} [snippetSuffix] Suffix for highlighted snippets
62117
+ * @param {number} [snippetTokenLimit] Maximum tokens in snippet
62118
+ * @param {number} [snippetMinLen] Minimum snippet length
62119
+ * @param {boolean} [includeSnippets] Include snippets in results
62120
+ * @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
62121
+ * @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
62122
+ * @param {number} [typoMax] Maximum typo tolerance
62123
+ * @param {number} [typoMinLen1] Min word length for 1 typo
62124
+ * @param {number} [typoMinLen2] Min word length for 2 typos
62125
+ * @param {number} [searchTimeoutMs] Search timeout in milliseconds
62126
+ * @param {boolean} [requireAllTerms] Require all search terms to match
62127
+ * @param {boolean} [exactMatchBoost] Boost exact matches
62128
+ * @param {boolean} [cacheResults] Cache search results
62129
+ * @param {boolean} [applyRules] Apply search rules
62130
+ * @param {string} [presetName] Search preset name to use
62131
+ * @param {string} [facetSearchText] Text to filter facet values
62329
62132
  * @param {*} [options] Override http request option.
62330
62133
  * @throws {RequiredError}
62331
- * @memberof SDKQuerySuggestionsConfigApi
62332
62134
  */
62333
- apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuerySuggestionsServiceQuerySuggestionsAPIResponse, any, {}>>;
62135
+ 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>;
62334
62136
  /**
62335
- * Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
62336
- * @summary Update query suggestions configuration
62137
+ * 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.
62138
+ * @summary Search (POST)
62337
62139
  * @param {string} xStoreid Store ID (from dashboard)
62338
- * @param {string} xStoreWriteSecret Store write secret
62339
- * @param {string} xStoreID Store ID (must match x-storeid header)
62340
- * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
62140
+ * @param {string} xStoresecret Store read secret (from dashboard)
62141
+ * @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
62142
+ * @param {string} [xUserId] User ID for personalization
62143
+ * @param {string} [xAnonId] Anonymous user ID for personalization
62144
+ * @param {string} [xSessionId] Session ID for personalization
62341
62145
  * @param {*} [options] Override http request option.
62342
62146
  * @throws {RequiredError}
62343
- * @memberof SDKQuerySuggestionsConfigApi
62344
62147
  */
62345
- apiV1StoresXStoreIDQuerySuggestionsConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuerySuggestionsServiceQuerySuggestionsAPIResponse, any, {}>>;
62346
- }
62148
+ v1SearchPost: (xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62149
+ };
62347
62150
  /**
62348
- * SDKSchemaApi - axios parameter creator
62151
+ * SearchApi - functional programming interface
62349
62152
  * @export
62350
62153
  */
62351
- export declare const SDKSchemaApiAxiosParamCreator: (configuration?: Configuration) => {
62154
+ export declare const SearchApiFp: (configuration?: Configuration) => {
62352
62155
  /**
62353
- * Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
62354
- * @summary Clear all documents
62355
- * @param {string} xStoreid Store ID (from dashboard)
62356
- * @param {string} xStoreWriteSecret Store write secret
62357
- * @param {string} xStoreID Store ID (must match x-storeid header)
62156
+ * Search documents with combined widget and document data, autocomplete suggestions, and configurable stopwords/synonyms
62157
+ * @summary Admin Search API
62158
+ * @param {string} xStoreID X-Store ID
62159
+ * @param {DataTypesAdminSearchRequest} dataTypesAdminSearchRequest Admin search request with optional stopword_sets and synonym_sets for granular control
62358
62160
  * @param {*} [options] Override http request option.
62359
62161
  * @throws {RequiredError}
62360
62162
  */
62361
- apiV1StoresXStoreIDDocumentsDelete: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62163
+ adminV1SearchXStoreIDPost(xStoreID: string, dataTypesAdminSearchRequest: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesCombinedSearchResponseWrapper>>;
62362
62164
  /**
62363
- * Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
62364
- * @summary Get index schema
62365
- * @param {string} xStoreid Store ID (from dashboard)
62366
- * @param {string} xStoresecret Store read secret
62367
- * @param {string} xStoreID Store ID (must match x-storeid header)
62165
+ * Get metadata about all configurable fields for dynamic form generation
62166
+ * @summary Get Configuration Schema
62167
+ * @param {string} [indexname] Index name to get field options from
62368
62168
  * @param {*} [options] Override http request option.
62369
62169
  * @throws {RequiredError}
62370
62170
  */
62371
- apiV1StoresXStoreIDSchemaGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62171
+ v1IndexConfigSchemaGet(indexname?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>>;
62372
62172
  /**
62373
- * Define or update the search index schema (field names, types, searchable/facet options). Mode: `additive` (add fields, keep data) or `replace` (recreate index). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
62374
- * @summary Create or update index schema
62375
- * @param {string} xStoreid Store ID (from dashboard)
62376
- * @param {string} xStoreWriteSecret Store write secret
62377
- * @param {string} xStoreID Store ID (must match x-storeid header)
62378
- * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
62173
+ * Get the current index configuration
62174
+ * @summary Get Index Config
62175
+ * @param {string} indexname Index Name
62379
62176
  * @param {*} [options] Override http request option.
62380
62177
  * @throws {RequiredError}
62381
62178
  */
62382
- apiV1StoresXStoreIDSchemaPost: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62383
- };
62384
- /**
62385
- * SDKSchemaApi - functional programming interface
62386
- * @export
62387
- */
62388
- export declare const SDKSchemaApiFp: (configuration?: Configuration) => {
62179
+ v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponseWrapper>>;
62389
62180
  /**
62390
- * Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
62391
- * @summary Clear all documents
62392
- * @param {string} xStoreid Store ID (from dashboard)
62393
- * @param {string} xStoreWriteSecret Store write secret
62394
- * @param {string} xStoreID Store ID (must match x-storeid header)
62181
+ * Configure the index for search
62182
+ * @summary Index Config
62183
+ * @param {string} indexname Index Name
62184
+ * @param {DataTypesIndexConfig} dataTypesIndexConfig Index configuration
62395
62185
  * @param {*} [options] Override http request option.
62396
62186
  * @throws {RequiredError}
62397
62187
  */
62398
- apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesClearDocumentsResponseWrapper>>;
62188
+ v1IndexIndexnameConfigPost(indexname: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
62399
62189
  /**
62400
- * Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
62401
- * @summary Get index schema
62190
+ * Update a single property of the index configuration
62191
+ * @summary Update Index Config Property
62192
+ * @param {string} indexname Index Name
62193
+ * @param {string} property Property name
62194
+ * @param {object} body Property value
62195
+ * @param {*} [options] Override http request option.
62196
+ * @throws {RequiredError}
62197
+ */
62198
+ v1IndexIndexnameConfigPropertyPatch(indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
62199
+ /**
62200
+ * Get default configuration values computed from the Typesense schema
62201
+ * @summary Get Schema-Based Defaults
62202
+ * @param {string} indexname Index Name
62203
+ * @param {*} [options] Override http request option.
62204
+ * @throws {RequiredError}
62205
+ */
62206
+ v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>>;
62207
+ /**
62208
+ * 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.
62209
+ * @summary Search (GET)
62402
62210
  * @param {string} xStoreid Store ID (from dashboard)
62403
- * @param {string} xStoresecret Store read secret
62404
- * @param {string} xStoreID Store ID (must match x-storeid header)
62211
+ * @param {string} xStoresecret Store read secret (from dashboard)
62212
+ * @param {string} q Search query
62213
+ * @param {string} [xUserId] User ID for personalization
62214
+ * @param {string} [xAnonId] Anonymous user ID for personalization
62215
+ * @param {string} [xSessionId] Session ID for personalization
62216
+ * @param {number} [page] Page number (default: 1)
62217
+ * @param {number} [perPage] Items per page (default: 10)
62218
+ * @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
62219
+ * @param {string} [filterBy] Filter string (e.g., category:shirts)
62220
+ * @param {string} [facetBy] Facet fields (comma-separated)
62221
+ * @param {number} [maxFacetValues] Maximum facet values to return
62222
+ * @param {boolean} [widgetMode] Return widget-formatted results
62223
+ * @param {boolean} [includeSuggestions] Include autocomplete suggestions
62224
+ * @param {number} [suggestionsLimit] Number of suggestions to return
62225
+ * @param {string} [analyticsTags] Analytics tags (comma-separated)
62226
+ * @param {string} [stopwordSets] Stopword set IDs (comma-separated)
62227
+ * @param {string} [synonymSets] Synonym set IDs (comma-separated)
62228
+ * @param {string} [searchFields] Fields to search in (comma-separated)
62229
+ * @param {string} [returnFields] Fields to return (comma-separated)
62230
+ * @param {string} [omitFields] Fields to omit (comma-separated)
62231
+ * @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
62232
+ * @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
62233
+ * @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
62234
+ * @param {string} [groupField] Field to group results by
62235
+ * @param {number} [groupSize] Number of results per group
62236
+ * @param {string} [snippetPrefix] Prefix for highlighted snippets
62237
+ * @param {string} [snippetSuffix] Suffix for highlighted snippets
62238
+ * @param {number} [snippetTokenLimit] Maximum tokens in snippet
62239
+ * @param {number} [snippetMinLen] Minimum snippet length
62240
+ * @param {boolean} [includeSnippets] Include snippets in results
62241
+ * @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
62242
+ * @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
62243
+ * @param {number} [typoMax] Maximum typo tolerance
62244
+ * @param {number} [typoMinLen1] Min word length for 1 typo
62245
+ * @param {number} [typoMinLen2] Min word length for 2 typos
62246
+ * @param {number} [searchTimeoutMs] Search timeout in milliseconds
62247
+ * @param {boolean} [requireAllTerms] Require all search terms to match
62248
+ * @param {boolean} [exactMatchBoost] Boost exact matches
62249
+ * @param {boolean} [cacheResults] Cache search results
62250
+ * @param {boolean} [applyRules] Apply search rules
62251
+ * @param {string} [presetName] Search preset name to use
62252
+ * @param {string} [facetSearchText] Text to filter facet values
62405
62253
  * @param {*} [options] Override http request option.
62406
62254
  * @throws {RequiredError}
62407
62255
  */
62408
- apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaResponseWrapper>>;
62256
+ 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>>;
62409
62257
  /**
62410
- * Define or update the search index schema (field names, types, searchable/facet options). Mode: `additive` (add fields, keep data) or `replace` (recreate index). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
62411
- * @summary Create or update index schema
62258
+ * 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.
62259
+ * @summary Search (POST)
62412
62260
  * @param {string} xStoreid Store ID (from dashboard)
62413
- * @param {string} xStoreWriteSecret Store write secret
62414
- * @param {string} xStoreID Store ID (must match x-storeid header)
62415
- * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
62261
+ * @param {string} xStoresecret Store read secret (from dashboard)
62262
+ * @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
62263
+ * @param {string} [xUserId] User ID for personalization
62264
+ * @param {string} [xAnonId] Anonymous user ID for personalization
62265
+ * @param {string} [xSessionId] Session ID for personalization
62416
62266
  * @param {*} [options] Override http request option.
62417
62267
  * @throws {RequiredError}
62418
62268
  */
62419
- apiV1StoresXStoreIDSchemaPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaResponseWrapper>>;
62269
+ v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOfficialSearchResponseWrapper>>;
62420
62270
  };
62421
62271
  /**
62422
- * SDKSchemaApi - factory interface
62272
+ * SearchApi - factory interface
62423
62273
  * @export
62424
62274
  */
62425
- export declare const SDKSchemaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
62275
+ export declare const SearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
62426
62276
  /**
62427
- * Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
62428
- * @summary Clear all documents
62429
- * @param {string} xStoreid Store ID (from dashboard)
62430
- * @param {string} xStoreWriteSecret Store write secret
62431
- * @param {string} xStoreID Store ID (must match x-storeid header)
62277
+ * Search documents with combined widget and document data, autocomplete suggestions, and configurable stopwords/synonyms
62278
+ * @summary Admin Search API
62279
+ * @param {string} xStoreID X-Store ID
62280
+ * @param {DataTypesAdminSearchRequest} dataTypesAdminSearchRequest Admin search request with optional stopword_sets and synonym_sets for granular control
62432
62281
  * @param {*} [options] Override http request option.
62433
62282
  * @throws {RequiredError}
62434
62283
  */
62435
- apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesClearDocumentsResponseWrapper>;
62284
+ adminV1SearchXStoreIDPost(xStoreID: string, dataTypesAdminSearchRequest: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesCombinedSearchResponseWrapper>;
62436
62285
  /**
62437
- * Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
62438
- * @summary Get index schema
62439
- * @param {string} xStoreid Store ID (from dashboard)
62440
- * @param {string} xStoresecret Store read secret
62441
- * @param {string} xStoreID Store ID (must match x-storeid header)
62286
+ * Get metadata about all configurable fields for dynamic form generation
62287
+ * @summary Get Configuration Schema
62288
+ * @param {string} [indexname] Index name to get field options from
62442
62289
  * @param {*} [options] Override http request option.
62443
62290
  * @throws {RequiredError}
62444
62291
  */
62445
- apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaResponseWrapper>;
62292
+ v1IndexConfigSchemaGet(indexname?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>;
62446
62293
  /**
62447
- * Define or update the search index schema (field names, types, searchable/facet options). Mode: `additive` (add fields, keep data) or `replace` (recreate index). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
62448
- * @summary Create or update index schema
62449
- * @param {string} xStoreid Store ID (from dashboard)
62450
- * @param {string} xStoreWriteSecret Store write secret
62451
- * @param {string} xStoreID Store ID (must match x-storeid header)
62452
- * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
62294
+ * Get the current index configuration
62295
+ * @summary Get Index Config
62296
+ * @param {string} indexname Index Name
62453
62297
  * @param {*} [options] Override http request option.
62454
62298
  * @throws {RequiredError}
62455
62299
  */
62456
- apiV1StoresXStoreIDSchemaPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaResponseWrapper>;
62457
- };
62458
- /**
62459
- * SDKSchemaApi - object-oriented interface
62460
- * @export
62461
- * @class SDKSchemaApi
62462
- * @extends {BaseAPI}
62463
- */
62464
- export declare class SDKSchemaApi extends BaseAPI {
62300
+ v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponseWrapper>;
62465
62301
  /**
62466
- * Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
62467
- * @summary Clear all documents
62468
- * @param {string} xStoreid Store ID (from dashboard)
62469
- * @param {string} xStoreWriteSecret Store write secret
62470
- * @param {string} xStoreID Store ID (must match x-storeid header)
62302
+ * Configure the index for search
62303
+ * @summary Index Config
62304
+ * @param {string} indexname Index Name
62305
+ * @param {DataTypesIndexConfig} dataTypesIndexConfig Index configuration
62471
62306
  * @param {*} [options] Override http request option.
62472
62307
  * @throws {RequiredError}
62473
- * @memberof SDKSchemaApi
62474
62308
  */
62475
- apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesClearDocumentsResponseWrapper, any, {}>>;
62309
+ v1IndexIndexnameConfigPost(indexname: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
62476
62310
  /**
62477
- * Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
62478
- * @summary Get index schema
62311
+ * Update a single property of the index configuration
62312
+ * @summary Update Index Config Property
62313
+ * @param {string} indexname Index Name
62314
+ * @param {string} property Property name
62315
+ * @param {object} body Property value
62316
+ * @param {*} [options] Override http request option.
62317
+ * @throws {RequiredError}
62318
+ */
62319
+ v1IndexIndexnameConfigPropertyPatch(indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
62320
+ /**
62321
+ * Get default configuration values computed from the Typesense schema
62322
+ * @summary Get Schema-Based Defaults
62323
+ * @param {string} indexname Index Name
62324
+ * @param {*} [options] Override http request option.
62325
+ * @throws {RequiredError}
62326
+ */
62327
+ v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>;
62328
+ /**
62329
+ * 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.
62330
+ * @summary Search (GET)
62479
62331
  * @param {string} xStoreid Store ID (from dashboard)
62480
- * @param {string} xStoresecret Store read secret
62481
- * @param {string} xStoreID Store ID (must match x-storeid header)
62332
+ * @param {string} xStoresecret Store read secret (from dashboard)
62333
+ * @param {string} q Search query
62334
+ * @param {string} [xUserId] User ID for personalization
62335
+ * @param {string} [xAnonId] Anonymous user ID for personalization
62336
+ * @param {string} [xSessionId] Session ID for personalization
62337
+ * @param {number} [page] Page number (default: 1)
62338
+ * @param {number} [perPage] Items per page (default: 10)
62339
+ * @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
62340
+ * @param {string} [filterBy] Filter string (e.g., category:shirts)
62341
+ * @param {string} [facetBy] Facet fields (comma-separated)
62342
+ * @param {number} [maxFacetValues] Maximum facet values to return
62343
+ * @param {boolean} [widgetMode] Return widget-formatted results
62344
+ * @param {boolean} [includeSuggestions] Include autocomplete suggestions
62345
+ * @param {number} [suggestionsLimit] Number of suggestions to return
62346
+ * @param {string} [analyticsTags] Analytics tags (comma-separated)
62347
+ * @param {string} [stopwordSets] Stopword set IDs (comma-separated)
62348
+ * @param {string} [synonymSets] Synonym set IDs (comma-separated)
62349
+ * @param {string} [searchFields] Fields to search in (comma-separated)
62350
+ * @param {string} [returnFields] Fields to return (comma-separated)
62351
+ * @param {string} [omitFields] Fields to omit (comma-separated)
62352
+ * @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
62353
+ * @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
62354
+ * @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
62355
+ * @param {string} [groupField] Field to group results by
62356
+ * @param {number} [groupSize] Number of results per group
62357
+ * @param {string} [snippetPrefix] Prefix for highlighted snippets
62358
+ * @param {string} [snippetSuffix] Suffix for highlighted snippets
62359
+ * @param {number} [snippetTokenLimit] Maximum tokens in snippet
62360
+ * @param {number} [snippetMinLen] Minimum snippet length
62361
+ * @param {boolean} [includeSnippets] Include snippets in results
62362
+ * @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
62363
+ * @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
62364
+ * @param {number} [typoMax] Maximum typo tolerance
62365
+ * @param {number} [typoMinLen1] Min word length for 1 typo
62366
+ * @param {number} [typoMinLen2] Min word length for 2 typos
62367
+ * @param {number} [searchTimeoutMs] Search timeout in milliseconds
62368
+ * @param {boolean} [requireAllTerms] Require all search terms to match
62369
+ * @param {boolean} [exactMatchBoost] Boost exact matches
62370
+ * @param {boolean} [cacheResults] Cache search results
62371
+ * @param {boolean} [applyRules] Apply search rules
62372
+ * @param {string} [presetName] Search preset name to use
62373
+ * @param {string} [facetSearchText] Text to filter facet values
62482
62374
  * @param {*} [options] Override http request option.
62483
62375
  * @throws {RequiredError}
62484
- * @memberof SDKSchemaApi
62485
62376
  */
62486
- apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaResponseWrapper, any, {}>>;
62377
+ 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>;
62487
62378
  /**
62488
- * Define or update the search index schema (field names, types, searchable/facet options). Mode: `additive` (add fields, keep data) or `replace` (recreate index). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
62489
- * @summary Create or update index schema
62379
+ * 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.
62380
+ * @summary Search (POST)
62490
62381
  * @param {string} xStoreid Store ID (from dashboard)
62491
- * @param {string} xStoreWriteSecret Store write secret
62492
- * @param {string} xStoreID Store ID (must match x-storeid header)
62493
- * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
62382
+ * @param {string} xStoresecret Store read secret (from dashboard)
62383
+ * @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
62384
+ * @param {string} [xUserId] User ID for personalization
62385
+ * @param {string} [xAnonId] Anonymous user ID for personalization
62386
+ * @param {string} [xSessionId] Session ID for personalization
62494
62387
  * @param {*} [options] Override http request option.
62495
62388
  * @throws {RequiredError}
62496
- * @memberof SDKSchemaApi
62497
62389
  */
62498
- apiV1StoresXStoreIDSchemaPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaResponseWrapper, any, {}>>;
62499
- }
62390
+ v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOfficialSearchResponseWrapper>;
62391
+ };
62500
62392
  /**
62501
- * SDKStoreConfigApi - axios parameter creator
62393
+ * SearchApi - object-oriented interface
62502
62394
  * @export
62395
+ * @class SearchApi
62396
+ * @extends {BaseAPI}
62503
62397
  */
62504
- export declare const SDKStoreConfigApiAxiosParamCreator: (configuration?: Configuration) => {
62398
+ export declare class SearchApi extends BaseAPI {
62505
62399
  /**
62506
- * Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
62507
- * @summary Get store configuration
62508
- * @param {string} xStoreid Store ID (from dashboard)
62509
- * @param {string} xStoresecret Store read secret
62510
- * @param {string} xStoreID Store ID (must match x-storeid header)
62400
+ * Search documents with combined widget and document data, autocomplete suggestions, and configurable stopwords/synonyms
62401
+ * @summary Admin Search API
62402
+ * @param {string} xStoreID X-Store ID
62403
+ * @param {DataTypesAdminSearchRequest} dataTypesAdminSearchRequest Admin search request with optional stopword_sets and synonym_sets for granular control
62511
62404
  * @param {*} [options] Override http request option.
62512
62405
  * @throws {RequiredError}
62406
+ * @memberof SearchApi
62513
62407
  */
62514
- apiV1StoresXStoreIDConfigGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62408
+ adminV1SearchXStoreIDPost(xStoreID: string, dataTypesAdminSearchRequest: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesCombinedSearchResponseWrapper, any, {}>>;
62515
62409
  /**
62516
- * Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
62517
- * @summary Update store configuration
62518
- * @param {string} xStoreid Store ID (from dashboard)
62519
- * @param {string} xStoreWriteSecret Store write secret
62520
- * @param {string} xStoreID Store ID (must match x-storeid header)
62521
- * @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
62410
+ * Get metadata about all configurable fields for dynamic form generation
62411
+ * @summary Get Configuration Schema
62412
+ * @param {string} [indexname] Index name to get field options from
62522
62413
  * @param {*} [options] Override http request option.
62523
62414
  * @throws {RequiredError}
62415
+ * @memberof SearchApi
62524
62416
  */
62525
- apiV1StoresXStoreIDConfigPut: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62417
+ v1IndexConfigSchemaGet(indexname?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesConfigurationSchemaResponseWrapper, any, {}>>;
62526
62418
  /**
62527
- * Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
62528
- * @summary Get store config schema
62529
- * @param {string} xStoreid Store ID (from dashboard)
62530
- * @param {string} xStoresecret Store read secret
62531
- * @param {string} xStoreID Store ID (must match x-storeid header)
62419
+ * Get the current index configuration
62420
+ * @summary Get Index Config
62421
+ * @param {string} indexname Index Name
62532
62422
  * @param {*} [options] Override http request option.
62533
62423
  * @throws {RequiredError}
62424
+ * @memberof SearchApi
62534
62425
  */
62535
- apiV1StoresXStoreIDConfigSchemaGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62536
- };
62537
- /**
62538
- * SDKStoreConfigApi - functional programming interface
62539
- * @export
62540
- */
62541
- export declare const SDKStoreConfigApiFp: (configuration?: Configuration) => {
62426
+ v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesIndexConfigResponseWrapper, any, {}>>;
62542
62427
  /**
62543
- * Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
62544
- * @summary Get store configuration
62545
- * @param {string} xStoreid Store ID (from dashboard)
62546
- * @param {string} xStoresecret Store read secret
62547
- * @param {string} xStoreID Store ID (must match x-storeid header)
62428
+ * Configure the index for search
62429
+ * @summary Index Config
62430
+ * @param {string} indexname Index Name
62431
+ * @param {DataTypesIndexConfig} dataTypesIndexConfig Index configuration
62548
62432
  * @param {*} [options] Override http request option.
62549
62433
  * @throws {RequiredError}
62434
+ * @memberof SearchApi
62550
62435
  */
62551
- apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse>>;
62436
+ v1IndexIndexnameConfigPost(indexname: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
62552
62437
  /**
62553
- * Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
62554
- * @summary Update store configuration
62438
+ * Update a single property of the index configuration
62439
+ * @summary Update Index Config Property
62440
+ * @param {string} indexname Index Name
62441
+ * @param {string} property Property name
62442
+ * @param {object} body Property value
62443
+ * @param {*} [options] Override http request option.
62444
+ * @throws {RequiredError}
62445
+ * @memberof SearchApi
62446
+ */
62447
+ v1IndexIndexnameConfigPropertyPatch(indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
62448
+ /**
62449
+ * Get default configuration values computed from the Typesense schema
62450
+ * @summary Get Schema-Based Defaults
62451
+ * @param {string} indexname Index Name
62452
+ * @param {*} [options] Override http request option.
62453
+ * @throws {RequiredError}
62454
+ * @memberof SearchApi
62455
+ */
62456
+ v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaBasedDefaultsResponseWrapper, any, {}>>;
62457
+ /**
62458
+ * 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.
62459
+ * @summary Search (GET)
62555
62460
  * @param {string} xStoreid Store ID (from dashboard)
62556
- * @param {string} xStoreWriteSecret Store write secret
62557
- * @param {string} xStoreID Store ID (must match x-storeid header)
62558
- * @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
62461
+ * @param {string} xStoresecret Store read secret (from dashboard)
62462
+ * @param {string} q Search query
62463
+ * @param {string} [xUserId] User ID for personalization
62464
+ * @param {string} [xAnonId] Anonymous user ID for personalization
62465
+ * @param {string} [xSessionId] Session ID for personalization
62466
+ * @param {number} [page] Page number (default: 1)
62467
+ * @param {number} [perPage] Items per page (default: 10)
62468
+ * @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
62469
+ * @param {string} [filterBy] Filter string (e.g., category:shirts)
62470
+ * @param {string} [facetBy] Facet fields (comma-separated)
62471
+ * @param {number} [maxFacetValues] Maximum facet values to return
62472
+ * @param {boolean} [widgetMode] Return widget-formatted results
62473
+ * @param {boolean} [includeSuggestions] Include autocomplete suggestions
62474
+ * @param {number} [suggestionsLimit] Number of suggestions to return
62475
+ * @param {string} [analyticsTags] Analytics tags (comma-separated)
62476
+ * @param {string} [stopwordSets] Stopword set IDs (comma-separated)
62477
+ * @param {string} [synonymSets] Synonym set IDs (comma-separated)
62478
+ * @param {string} [searchFields] Fields to search in (comma-separated)
62479
+ * @param {string} [returnFields] Fields to return (comma-separated)
62480
+ * @param {string} [omitFields] Fields to omit (comma-separated)
62481
+ * @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
62482
+ * @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
62483
+ * @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
62484
+ * @param {string} [groupField] Field to group results by
62485
+ * @param {number} [groupSize] Number of results per group
62486
+ * @param {string} [snippetPrefix] Prefix for highlighted snippets
62487
+ * @param {string} [snippetSuffix] Suffix for highlighted snippets
62488
+ * @param {number} [snippetTokenLimit] Maximum tokens in snippet
62489
+ * @param {number} [snippetMinLen] Minimum snippet length
62490
+ * @param {boolean} [includeSnippets] Include snippets in results
62491
+ * @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
62492
+ * @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
62493
+ * @param {number} [typoMax] Maximum typo tolerance
62494
+ * @param {number} [typoMinLen1] Min word length for 1 typo
62495
+ * @param {number} [typoMinLen2] Min word length for 2 typos
62496
+ * @param {number} [searchTimeoutMs] Search timeout in milliseconds
62497
+ * @param {boolean} [requireAllTerms] Require all search terms to match
62498
+ * @param {boolean} [exactMatchBoost] Boost exact matches
62499
+ * @param {boolean} [cacheResults] Cache search results
62500
+ * @param {boolean} [applyRules] Apply search rules
62501
+ * @param {string} [presetName] Search preset name to use
62502
+ * @param {string} [facetSearchText] Text to filter facet values
62559
62503
  * @param {*} [options] Override http request option.
62560
62504
  * @throws {RequiredError}
62505
+ * @memberof SearchApi
62561
62506
  */
62562
- apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponseWrapper>>;
62507
+ v1SearchGet(xStoreid: string, xStoresecret: string, q: string, xUserId?: string, xAnonId?: string, xSessionId?: string, page?: number, perPage?: number, sortBy?: string, filterBy?: string, facetBy?: string, maxFacetValues?: number, widgetMode?: boolean, includeSuggestions?: boolean, suggestionsLimit?: number, analyticsTags?: string, stopwordSets?: string, synonymSets?: string, searchFields?: string, returnFields?: string, omitFields?: string, snippetFields?: string, fullSnippetFields?: string, fieldWeights?: string, groupField?: string, groupSize?: number, snippetPrefix?: string, snippetSuffix?: string, snippetTokenLimit?: number, snippetMinLen?: number, includeSnippets?: boolean, prefixMode?: string, infixMode?: string, typoMax?: number, typoMinLen1?: number, typoMinLen2?: number, searchTimeoutMs?: number, requireAllTerms?: boolean, exactMatchBoost?: boolean, cacheResults?: boolean, applyRules?: boolean, presetName?: string, facetSearchText?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOfficialSearchResponseWrapper, any, {}>>;
62563
62508
  /**
62564
- * Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
62565
- * @summary Get store config schema
62509
+ * 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.
62510
+ * @summary Search (POST)
62566
62511
  * @param {string} xStoreid Store ID (from dashboard)
62567
- * @param {string} xStoresecret Store read secret
62568
- * @param {string} xStoreID Store ID (must match x-storeid header)
62512
+ * @param {string} xStoresecret Store read secret (from dashboard)
62513
+ * @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
62514
+ * @param {string} [xUserId] User ID for personalization
62515
+ * @param {string} [xAnonId] Anonymous user ID for personalization
62516
+ * @param {string} [xSessionId] Session ID for personalization
62569
62517
  * @param {*} [options] Override http request option.
62570
62518
  * @throws {RequiredError}
62519
+ * @memberof SearchApi
62571
62520
  */
62572
- apiV1StoresXStoreIDConfigSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>>;
62573
- };
62521
+ v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOfficialSearchResponseWrapper, any, {}>>;
62522
+ }
62574
62523
  /**
62575
- * SDKStoreConfigApi - factory interface
62524
+ * StopwordsApi - axios parameter creator
62576
62525
  * @export
62577
62526
  */
62578
- export declare const SDKStoreConfigApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
62527
+ export declare const StopwordsApiAxiosParamCreator: (configuration?: Configuration) => {
62579
62528
  /**
62580
- * Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
62581
- * @summary Get store configuration
62582
- * @param {string} xStoreid Store ID (from dashboard)
62583
- * @param {string} xStoresecret Store read secret
62584
- * @param {string} xStoreID Store ID (must match x-storeid header)
62529
+ * Fetches available languages/locales with pagination
62530
+ * @summary Get available languages
62531
+ * @param {string} [type] Type filter (stopwords, synonyms)
62532
+ * @param {number} [page] Page number (default: 1)
62533
+ * @param {number} [limit] Items per page (default: 10)
62585
62534
  * @param {*} [options] Override http request option.
62586
62535
  * @throws {RequiredError}
62587
62536
  */
62588
- apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse>;
62537
+ adminStoresStopwordsLanguagesGet: (type?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62589
62538
  /**
62590
- * Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
62591
- * @summary Update store configuration
62592
- * @param {string} xStoreid Store ID (from dashboard)
62593
- * @param {string} xStoreWriteSecret Store write secret
62594
- * @param {string} xStoreID Store ID (must match x-storeid header)
62595
- * @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
62539
+ * Enables or disables a specific word for a store. Supports default words, store-specific words, and custom words.
62540
+ * @summary Update word status for store
62541
+ * @param {string} xStoreID X-Store ID
62542
+ * @param {DataTypesUpdateWordStatusRequest} dataTypesUpdateWordStatusRequest Word status update request. Use wordid for default words, store_language_wordid for store-specific words, or custom_wordid for custom words. Set word_type accordingly.
62596
62543
  * @param {*} [options] Override http request option.
62597
62544
  * @throws {RequiredError}
62598
62545
  */
62599
- apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponseWrapper>;
62546
+ adminStoresXStoreIDStopwordsWordStatusPut: (xStoreID: string, dataTypesUpdateWordStatusRequest: DataTypesUpdateWordStatusRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62600
62547
  /**
62601
- * Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
62602
- * @summary Get store config schema
62603
- * @param {string} xStoreid Store ID (from dashboard)
62604
- * @param {string} xStoresecret Store read secret
62605
- * @param {string} xStoreID Store ID (must match x-storeid header)
62548
+ * Fetches a single word list by language with pagination on words within the wordlist
62549
+ * @summary Get word lists by language
62550
+ * @param {string} xStoreID X-Store ID
62551
+ * @param {string} [lang] Language locale filter (e.g. \&#39;en\&#39;, \&#39;ar\&#39;)
62552
+ * @param {string} [type] Type filter (stopwords, synonyms)
62553
+ * @param {number} [page] Page number (default: 1)
62554
+ * @param {number} [limit] Items per page (default: 10)
62606
62555
  * @param {*} [options] Override http request option.
62607
62556
  * @throws {RequiredError}
62608
62557
  */
62609
- apiV1StoresXStoreIDConfigSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>;
62610
- };
62611
- /**
62612
- * SDKStoreConfigApi - object-oriented interface
62613
- * @export
62614
- * @class SDKStoreConfigApi
62615
- * @extends {BaseAPI}
62616
- */
62617
- export declare class SDKStoreConfigApi extends BaseAPI {
62558
+ adminStoresXStoreIDStopwordsWordlistsGet: (xStoreID: string, lang?: string, type?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62618
62559
  /**
62619
- * Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
62620
- * @summary Get store configuration
62621
- * @param {string} xStoreid Store ID (from dashboard)
62622
- * @param {string} xStoresecret Store read secret
62623
- * @param {string} xStoreID Store ID (must match x-storeid header)
62560
+ * Fetches a single word list by language with pagination on words, including store-specific enabled/disabled status and store-specific added words. Supports search functionality.
62561
+ * @summary Get word lists by language (includes store-specific words)
62562
+ * @param {string} xStoreID X-Store ID
62563
+ * @param {string} [lang] Language locale filter (e.g. \&#39;en\&#39;, \&#39;ar\&#39;)
62564
+ * @param {string} [type] Type filter (stopwords, synonyms)
62565
+ * @param {string} [q] Search query to filter words (case-insensitive)
62566
+ * @param {number} [page] Page number (default: 1)
62567
+ * @param {number} [limit] Items per page (default: 10)
62624
62568
  * @param {*} [options] Override http request option.
62625
62569
  * @throws {RequiredError}
62626
- * @memberof SDKStoreConfigApi
62627
62570
  */
62628
- apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse, any, {}>>;
62571
+ adminStoresXStoreIDStopwordsWordlistsWithStoreWordsGet: (xStoreID: string, lang?: string, type?: string, q?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62629
62572
  /**
62630
- * Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
62631
- * @summary Update store configuration
62632
- * @param {string} xStoreid Store ID (from dashboard)
62633
- * @param {string} xStoreWriteSecret Store write secret
62634
- * @param {string} xStoreID Store ID (must match x-storeid header)
62635
- * @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
62573
+ * Removes store-specific words from a language word list ## 🔎 Activity Logs Generated This operation **records an Activity Log entry** with: - **Action:** update - **Resource Type:** stopword_list - **Resource ID:** xStoreID - **Description:** Includes number of words removed & details - **State Before:** `{ removed_words: [..], count: N }` - **State After:** `{ removed_words: [], count: 0 }` - **Changed Fields:** `[ \"words_removed(N)\" ]` ---
62574
+ * @summary Remove words from language word list
62575
+ * @param {string} xStoreID X-Store ID
62576
+ * @param {number} wordListID Word List ID
62577
+ * @param {DataTypesRemoveWordsFromLanguageListRequest} dataTypesRemoveWordsFromLanguageListRequest Remove words request
62636
62578
  * @param {*} [options] Override http request option.
62637
62579
  * @throws {RequiredError}
62638
- * @memberof SDKStoreConfigApi
62639
62580
  */
62640
- apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesIndexConfigResponseWrapper, any, {}>>;
62581
+ adminStoresXStoreIDStopwordsWordlistsWordListIDWordsDelete: (xStoreID: string, wordListID: number, dataTypesRemoveWordsFromLanguageListRequest: DataTypesRemoveWordsFromLanguageListRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62641
62582
  /**
62642
- * Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
62643
- * @summary Get store config schema
62644
- * @param {string} xStoreid Store ID (from dashboard)
62645
- * @param {string} xStoresecret Store read secret
62646
- * @param {string} xStoreID Store ID (must match x-storeid header)
62583
+ * Adds one or more words to a language-based stopword list for a store. Also records Activity Logs capturing before/after state and changed fields.
62584
+ * @summary Add words to language word list
62585
+ * @param {string} xStoreID X-Store ID
62586
+ * @param {number} wordListID Word List ID
62587
+ * @param {DataTypesAddWordsToLanguageListRequest} dataTypesAddWordsToLanguageListRequest Add words request
62647
62588
  * @param {*} [options] Override http request option.
62648
62589
  * @throws {RequiredError}
62649
- * @memberof SDKStoreConfigApi
62650
62590
  */
62651
- apiV1StoresXStoreIDConfigSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesConfigurationSchemaResponseWrapper, any, {}>>;
62652
- }
62591
+ adminStoresXStoreIDStopwordsWordlistsWordListIDWordsPost: (xStoreID: string, wordListID: number, dataTypesAddWordsToLanguageListRequest: DataTypesAddWordsToLanguageListRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62592
+ };
62653
62593
  /**
62654
- * SDKStoreCreationApi - axios parameter creator
62594
+ * StopwordsApi - functional programming interface
62655
62595
  * @export
62656
62596
  */
62657
- export declare const SDKStoreCreationApiAxiosParamCreator: (configuration?: Configuration) => {
62597
+ export declare const StopwordsApiFp: (configuration?: Configuration) => {
62658
62598
  /**
62659
- * Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
62660
- * @summary Create Store (Public SDK API)
62661
- * @param {string} authorization Bearer JWT Token
62662
- * @param {DataTypesPublicCreateStoreRequest} dataTypesPublicCreateStoreRequest Store creation request
62599
+ * Fetches available languages/locales with pagination
62600
+ * @summary Get available languages
62601
+ * @param {string} [type] Type filter (stopwords, synonyms)
62602
+ * @param {number} [page] Page number (default: 1)
62603
+ * @param {number} [limit] Items per page (default: 10)
62663
62604
  * @param {*} [options] Override http request option.
62664
62605
  * @throws {RequiredError}
62665
62606
  */
62666
- apiV1StoresPost: (authorization: string, dataTypesPublicCreateStoreRequest: DataTypesPublicCreateStoreRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62667
- };
62668
- /**
62669
- * SDKStoreCreationApi - functional programming interface
62670
- * @export
62671
- */
62672
- export declare const SDKStoreCreationApiFp: (configuration?: Configuration) => {
62607
+ adminStoresStopwordsLanguagesGet(type?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesLanguagesResponseWrapper>>;
62673
62608
  /**
62674
- * Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
62675
- * @summary Create Store (Public SDK API)
62676
- * @param {string} authorization Bearer JWT Token
62677
- * @param {DataTypesPublicCreateStoreRequest} dataTypesPublicCreateStoreRequest Store creation request
62609
+ * Enables or disables a specific word for a store. Supports default words, store-specific words, and custom words.
62610
+ * @summary Update word status for store
62611
+ * @param {string} xStoreID X-Store ID
62612
+ * @param {DataTypesUpdateWordStatusRequest} dataTypesUpdateWordStatusRequest Word status update request. Use wordid for default words, store_language_wordid for store-specific words, or custom_wordid for custom words. Set word_type accordingly.
62678
62613
  * @param {*} [options] Override http request option.
62679
62614
  * @throws {RequiredError}
62680
62615
  */
62681
- apiV1StoresPost(authorization: string, dataTypesPublicCreateStoreRequest: DataTypesPublicCreateStoreRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesPublicCreateStoreResponse>>;
62682
- };
62683
- /**
62684
- * SDKStoreCreationApi - factory interface
62685
- * @export
62686
- */
62687
- export declare const SDKStoreCreationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
62616
+ adminStoresXStoreIDStopwordsWordStatusPut(xStoreID: string, dataTypesUpdateWordStatusRequest: DataTypesUpdateWordStatusRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesUpdateWordStatusResponseWrapper>>;
62688
62617
  /**
62689
- * Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
62690
- * @summary Create Store (Public SDK API)
62691
- * @param {string} authorization Bearer JWT Token
62692
- * @param {DataTypesPublicCreateStoreRequest} dataTypesPublicCreateStoreRequest Store creation request
62618
+ * Fetches a single word list by language with pagination on words within the wordlist
62619
+ * @summary Get word lists by language
62620
+ * @param {string} xStoreID X-Store ID
62621
+ * @param {string} [lang] Language locale filter (e.g. \&#39;en\&#39;, \&#39;ar\&#39;)
62622
+ * @param {string} [type] Type filter (stopwords, synonyms)
62623
+ * @param {number} [page] Page number (default: 1)
62624
+ * @param {number} [limit] Items per page (default: 10)
62693
62625
  * @param {*} [options] Override http request option.
62694
62626
  * @throws {RequiredError}
62695
62627
  */
62696
- apiV1StoresPost(authorization: string, dataTypesPublicCreateStoreRequest: DataTypesPublicCreateStoreRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesPublicCreateStoreResponse>;
62697
- };
62698
- /**
62699
- * SDKStoreCreationApi - object-oriented interface
62700
- * @export
62701
- * @class SDKStoreCreationApi
62702
- * @extends {BaseAPI}
62703
- */
62704
- export declare class SDKStoreCreationApi extends BaseAPI {
62628
+ adminStoresXStoreIDStopwordsWordlistsGet(xStoreID: string, lang?: string, type?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesWordListResponseWrapper>>;
62705
62629
  /**
62706
- * Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
62707
- * @summary Create Store (Public SDK API)
62708
- * @param {string} authorization Bearer JWT Token
62709
- * @param {DataTypesPublicCreateStoreRequest} dataTypesPublicCreateStoreRequest Store creation request
62630
+ * Fetches a single word list by language with pagination on words, including store-specific enabled/disabled status and store-specific added words. Supports search functionality.
62631
+ * @summary Get word lists by language (includes store-specific words)
62632
+ * @param {string} xStoreID X-Store ID
62633
+ * @param {string} [lang] Language locale filter (e.g. \&#39;en\&#39;, \&#39;ar\&#39;)
62634
+ * @param {string} [type] Type filter (stopwords, synonyms)
62635
+ * @param {string} [q] Search query to filter words (case-insensitive)
62636
+ * @param {number} [page] Page number (default: 1)
62637
+ * @param {number} [limit] Items per page (default: 10)
62710
62638
  * @param {*} [options] Override http request option.
62711
62639
  * @throws {RequiredError}
62712
- * @memberof SDKStoreCreationApi
62713
62640
  */
62714
- apiV1StoresPost(authorization: string, dataTypesPublicCreateStoreRequest: DataTypesPublicCreateStoreRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesPublicCreateStoreResponse, any, {}>>;
62715
- }
62716
- /**
62717
- * SDKStoreInfoApi - axios parameter creator
62718
- * @export
62719
- */
62720
- export declare const SDKStoreInfoApiAxiosParamCreator: (configuration?: Configuration) => {
62641
+ adminStoresXStoreIDStopwordsWordlistsWithStoreWordsGet(xStoreID: string, lang?: string, type?: string, q?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesWordListResponseEnhancedWrapper>>;
62721
62642
  /**
62722
- * Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
62723
- * @summary Get store info
62724
- * @param {string} xStoreid Store ID (from dashboard)
62725
- * @param {string} xStoresecret Store read secret
62726
- * @param {string} xStoreID Store ID (must match x-storeid header)
62643
+ * Removes store-specific words from a language word list ## 🔎 Activity Logs Generated This operation **records an Activity Log entry** with: - **Action:** update - **Resource Type:** stopword_list - **Resource ID:** xStoreID - **Description:** Includes number of words removed & details - **State Before:** `{ removed_words: [..], count: N }` - **State After:** `{ removed_words: [], count: 0 }` - **Changed Fields:** `[ \"words_removed(N)\" ]` ---
62644
+ * @summary Remove words from language word list
62645
+ * @param {string} xStoreID X-Store ID
62646
+ * @param {number} wordListID Word List ID
62647
+ * @param {DataTypesRemoveWordsFromLanguageListRequest} dataTypesRemoveWordsFromLanguageListRequest Remove words request
62727
62648
  * @param {*} [options] Override http request option.
62728
62649
  * @throws {RequiredError}
62729
62650
  */
62730
- apiV1StoresXStoreIDGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62731
- };
62732
- /**
62733
- * SDKStoreInfoApi - functional programming interface
62734
- * @export
62735
- */
62736
- export declare const SDKStoreInfoApiFp: (configuration?: Configuration) => {
62651
+ adminStoresXStoreIDStopwordsWordlistsWordListIDWordsDelete(xStoreID: string, wordListID: number, dataTypesRemoveWordsFromLanguageListRequest: DataTypesRemoveWordsFromLanguageListRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesUpdateWordStatusResponseWrapper>>;
62737
62652
  /**
62738
- * Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
62739
- * @summary Get store info
62740
- * @param {string} xStoreid Store ID (from dashboard)
62741
- * @param {string} xStoresecret Store read secret
62742
- * @param {string} xStoreID Store ID (must match x-storeid header)
62653
+ * Adds one or more words to a language-based stopword list for a store. Also records Activity Logs capturing before/after state and changed fields.
62654
+ * @summary Add words to language word list
62655
+ * @param {string} xStoreID X-Store ID
62656
+ * @param {number} wordListID Word List ID
62657
+ * @param {DataTypesAddWordsToLanguageListRequest} dataTypesAddWordsToLanguageListRequest Add words request
62743
62658
  * @param {*} [options] Override http request option.
62744
62659
  * @throws {RequiredError}
62745
62660
  */
62746
- apiV1StoresXStoreIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesPublicStoreInfoResponse>>;
62661
+ adminStoresXStoreIDStopwordsWordlistsWordListIDWordsPost(xStoreID: string, wordListID: number, dataTypesAddWordsToLanguageListRequest: DataTypesAddWordsToLanguageListRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesUpdateWordStatusResponseWrapper>>;
62747
62662
  };
62748
62663
  /**
62749
- * SDKStoreInfoApi - factory interface
62664
+ * StopwordsApi - factory interface
62750
62665
  * @export
62751
62666
  */
62752
- export declare const SDKStoreInfoApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
62667
+ export declare const StopwordsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
62753
62668
  /**
62754
- * Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
62755
- * @summary Get store info
62756
- * @param {string} xStoreid Store ID (from dashboard)
62757
- * @param {string} xStoresecret Store read secret
62758
- * @param {string} xStoreID Store ID (must match x-storeid header)
62669
+ * Fetches available languages/locales with pagination
62670
+ * @summary Get available languages
62671
+ * @param {string} [type] Type filter (stopwords, synonyms)
62672
+ * @param {number} [page] Page number (default: 1)
62673
+ * @param {number} [limit] Items per page (default: 10)
62759
62674
  * @param {*} [options] Override http request option.
62760
62675
  * @throws {RequiredError}
62761
62676
  */
62762
- apiV1StoresXStoreIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesPublicStoreInfoResponse>;
62763
- };
62764
- /**
62765
- * SDKStoreInfoApi - object-oriented interface
62766
- * @export
62767
- * @class SDKStoreInfoApi
62768
- * @extends {BaseAPI}
62769
- */
62770
- export declare class SDKStoreInfoApi extends BaseAPI {
62677
+ adminStoresStopwordsLanguagesGet(type?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesLanguagesResponseWrapper>;
62771
62678
  /**
62772
- * Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
62773
- * @summary Get store info
62774
- * @param {string} xStoreid Store ID (from dashboard)
62775
- * @param {string} xStoresecret Store read secret
62776
- * @param {string} xStoreID Store ID (must match x-storeid header)
62679
+ * Enables or disables a specific word for a store. Supports default words, store-specific words, and custom words.
62680
+ * @summary Update word status for store
62681
+ * @param {string} xStoreID X-Store ID
62682
+ * @param {DataTypesUpdateWordStatusRequest} dataTypesUpdateWordStatusRequest Word status update request. Use wordid for default words, store_language_wordid for store-specific words, or custom_wordid for custom words. Set word_type accordingly.
62777
62683
  * @param {*} [options] Override http request option.
62778
62684
  * @throws {RequiredError}
62779
- * @memberof SDKStoreInfoApi
62780
62685
  */
62781
- apiV1StoresXStoreIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesPublicStoreInfoResponse, any, {}>>;
62782
- }
62783
- /**
62784
- * SearchApi - axios parameter creator
62785
- * @export
62786
- */
62787
- export declare const SearchApiAxiosParamCreator: (configuration?: Configuration) => {
62686
+ adminStoresXStoreIDStopwordsWordStatusPut(xStoreID: string, dataTypesUpdateWordStatusRequest: DataTypesUpdateWordStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesUpdateWordStatusResponseWrapper>;
62687
+ /**
62688
+ * Fetches a single word list by language with pagination on words within the wordlist
62689
+ * @summary Get word lists by language
62690
+ * @param {string} xStoreID X-Store ID
62691
+ * @param {string} [lang] Language locale filter (e.g. \&#39;en\&#39;, \&#39;ar\&#39;)
62692
+ * @param {string} [type] Type filter (stopwords, synonyms)
62693
+ * @param {number} [page] Page number (default: 1)
62694
+ * @param {number} [limit] Items per page (default: 10)
62695
+ * @param {*} [options] Override http request option.
62696
+ * @throws {RequiredError}
62697
+ */
62698
+ adminStoresXStoreIDStopwordsWordlistsGet(xStoreID: string, lang?: string, type?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesWordListResponseWrapper>;
62699
+ /**
62700
+ * Fetches a single word list by language with pagination on words, including store-specific enabled/disabled status and store-specific added words. Supports search functionality.
62701
+ * @summary Get word lists by language (includes store-specific words)
62702
+ * @param {string} xStoreID X-Store ID
62703
+ * @param {string} [lang] Language locale filter (e.g. \&#39;en\&#39;, \&#39;ar\&#39;)
62704
+ * @param {string} [type] Type filter (stopwords, synonyms)
62705
+ * @param {string} [q] Search query to filter words (case-insensitive)
62706
+ * @param {number} [page] Page number (default: 1)
62707
+ * @param {number} [limit] Items per page (default: 10)
62708
+ * @param {*} [options] Override http request option.
62709
+ * @throws {RequiredError}
62710
+ */
62711
+ adminStoresXStoreIDStopwordsWordlistsWithStoreWordsGet(xStoreID: string, lang?: string, type?: string, q?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesWordListResponseEnhancedWrapper>;
62788
62712
  /**
62789
- * Search documents with combined widget and document data, autocomplete suggestions, and configurable stopwords/synonyms
62790
- * @summary Admin Search API
62713
+ * Removes store-specific words from a language word list ## 🔎 Activity Logs Generated This operation **records an Activity Log entry** with: - **Action:** update - **Resource Type:** stopword_list - **Resource ID:** xStoreID - **Description:** Includes number of words removed & details - **State Before:** `{ removed_words: [..], count: N }` - **State After:** `{ removed_words: [], count: 0 }` - **Changed Fields:** `[ \"words_removed(N)\" ]` ---
62714
+ * @summary Remove words from language word list
62791
62715
  * @param {string} xStoreID X-Store ID
62792
- * @param {DataTypesAdminSearchRequest} dataTypesAdminSearchRequest Admin search request with optional stopword_sets and synonym_sets for granular control
62716
+ * @param {number} wordListID Word List ID
62717
+ * @param {DataTypesRemoveWordsFromLanguageListRequest} dataTypesRemoveWordsFromLanguageListRequest Remove words request
62793
62718
  * @param {*} [options] Override http request option.
62794
62719
  * @throws {RequiredError}
62795
62720
  */
62796
- adminV1SearchXStoreIDPost: (xStoreID: string, dataTypesAdminSearchRequest: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62721
+ adminStoresXStoreIDStopwordsWordlistsWordListIDWordsDelete(xStoreID: string, wordListID: number, dataTypesRemoveWordsFromLanguageListRequest: DataTypesRemoveWordsFromLanguageListRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesUpdateWordStatusResponseWrapper>;
62797
62722
  /**
62798
- * Get metadata about all configurable fields for dynamic form generation
62799
- * @summary Get Configuration Schema
62800
- * @param {string} [indexname] Index name to get field options from
62723
+ * Adds one or more words to a language-based stopword list for a store. Also records Activity Logs capturing before/after state and changed fields.
62724
+ * @summary Add words to language word list
62725
+ * @param {string} xStoreID X-Store ID
62726
+ * @param {number} wordListID Word List ID
62727
+ * @param {DataTypesAddWordsToLanguageListRequest} dataTypesAddWordsToLanguageListRequest Add words request
62801
62728
  * @param {*} [options] Override http request option.
62802
62729
  * @throws {RequiredError}
62803
62730
  */
62804
- v1IndexConfigSchemaGet: (indexname?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62731
+ adminStoresXStoreIDStopwordsWordlistsWordListIDWordsPost(xStoreID: string, wordListID: number, dataTypesAddWordsToLanguageListRequest: DataTypesAddWordsToLanguageListRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesUpdateWordStatusResponseWrapper>;
62732
+ };
62733
+ /**
62734
+ * StopwordsApi - object-oriented interface
62735
+ * @export
62736
+ * @class StopwordsApi
62737
+ * @extends {BaseAPI}
62738
+ */
62739
+ export declare class StopwordsApi extends BaseAPI {
62805
62740
  /**
62806
- * Get the current index configuration
62807
- * @summary Get Index Config
62808
- * @param {string} indexname Index Name
62741
+ * Fetches available languages/locales with pagination
62742
+ * @summary Get available languages
62743
+ * @param {string} [type] Type filter (stopwords, synonyms)
62744
+ * @param {number} [page] Page number (default: 1)
62745
+ * @param {number} [limit] Items per page (default: 10)
62809
62746
  * @param {*} [options] Override http request option.
62810
62747
  * @throws {RequiredError}
62748
+ * @memberof StopwordsApi
62811
62749
  */
62812
- v1IndexIndexnameConfigGet: (indexname: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62750
+ adminStoresStopwordsLanguagesGet(type?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesLanguagesResponseWrapper, any, {}>>;
62813
62751
  /**
62814
- * Configure the index for search
62815
- * @summary Index Config
62816
- * @param {string} indexname Index Name
62817
- * @param {DataTypesIndexConfig} dataTypesIndexConfig Index configuration
62752
+ * Enables or disables a specific word for a store. Supports default words, store-specific words, and custom words.
62753
+ * @summary Update word status for store
62754
+ * @param {string} xStoreID X-Store ID
62755
+ * @param {DataTypesUpdateWordStatusRequest} dataTypesUpdateWordStatusRequest Word status update request. Use wordid for default words, store_language_wordid for store-specific words, or custom_wordid for custom words. Set word_type accordingly.
62818
62756
  * @param {*} [options] Override http request option.
62819
62757
  * @throws {RequiredError}
62758
+ * @memberof StopwordsApi
62820
62759
  */
62821
- v1IndexIndexnameConfigPost: (indexname: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62760
+ adminStoresXStoreIDStopwordsWordStatusPut(xStoreID: string, dataTypesUpdateWordStatusRequest: DataTypesUpdateWordStatusRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesUpdateWordStatusResponseWrapper, any, {}>>;
62822
62761
  /**
62823
- * Update a single property of the index configuration
62824
- * @summary Update Index Config Property
62825
- * @param {string} indexname Index Name
62826
- * @param {string} property Property name
62827
- * @param {object} body Property value
62762
+ * Fetches a single word list by language with pagination on words within the wordlist
62763
+ * @summary Get word lists by language
62764
+ * @param {string} xStoreID X-Store ID
62765
+ * @param {string} [lang] Language locale filter (e.g. \&#39;en\&#39;, \&#39;ar\&#39;)
62766
+ * @param {string} [type] Type filter (stopwords, synonyms)
62767
+ * @param {number} [page] Page number (default: 1)
62768
+ * @param {number} [limit] Items per page (default: 10)
62828
62769
  * @param {*} [options] Override http request option.
62829
62770
  * @throws {RequiredError}
62771
+ * @memberof StopwordsApi
62830
62772
  */
62831
- v1IndexIndexnameConfigPropertyPatch: (indexname: string, property: string, body: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62773
+ adminStoresXStoreIDStopwordsWordlistsGet(xStoreID: string, lang?: string, type?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesWordListResponseWrapper, any, {}>>;
62832
62774
  /**
62833
- * Get default configuration values computed from the Typesense schema
62834
- * @summary Get Schema-Based Defaults
62835
- * @param {string} indexname Index Name
62775
+ * Fetches a single word list by language with pagination on words, including store-specific enabled/disabled status and store-specific added words. Supports search functionality.
62776
+ * @summary Get word lists by language (includes store-specific words)
62777
+ * @param {string} xStoreID X-Store ID
62778
+ * @param {string} [lang] Language locale filter (e.g. \&#39;en\&#39;, \&#39;ar\&#39;)
62779
+ * @param {string} [type] Type filter (stopwords, synonyms)
62780
+ * @param {string} [q] Search query to filter words (case-insensitive)
62781
+ * @param {number} [page] Page number (default: 1)
62782
+ * @param {number} [limit] Items per page (default: 10)
62836
62783
  * @param {*} [options] Override http request option.
62837
62784
  * @throws {RequiredError}
62785
+ * @memberof StopwordsApi
62838
62786
  */
62839
- v1IndexIndexnameDefaultsGet: (indexname: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62787
+ adminStoresXStoreIDStopwordsWordlistsWithStoreWordsGet(xStoreID: string, lang?: string, type?: string, q?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesWordListResponseEnhancedWrapper, any, {}>>;
62840
62788
  /**
62841
- * 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.
62842
- * @summary Search (GET)
62843
- * @param {string} xStoreid Store ID (from dashboard)
62844
- * @param {string} xStoresecret Store read secret (from dashboard)
62845
- * @param {string} q Search query
62846
- * @param {string} [xUserId] User ID for personalization
62847
- * @param {string} [xAnonId] Anonymous user ID for personalization
62848
- * @param {string} [xSessionId] Session ID for personalization
62849
- * @param {number} [page] Page number (default: 1)
62850
- * @param {number} [perPage] Items per page (default: 10)
62851
- * @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
62852
- * @param {string} [filterBy] Filter string (e.g., category:shirts)
62853
- * @param {string} [facetBy] Facet fields (comma-separated)
62854
- * @param {number} [maxFacetValues] Maximum facet values to return
62855
- * @param {boolean} [widgetMode] Return widget-formatted results
62856
- * @param {boolean} [includeSuggestions] Include autocomplete suggestions
62857
- * @param {number} [suggestionsLimit] Number of suggestions to return
62858
- * @param {string} [analyticsTags] Analytics tags (comma-separated)
62859
- * @param {string} [stopwordSets] Stopword set IDs (comma-separated)
62860
- * @param {string} [synonymSets] Synonym set IDs (comma-separated)
62861
- * @param {string} [searchFields] Fields to search in (comma-separated)
62862
- * @param {string} [returnFields] Fields to return (comma-separated)
62863
- * @param {string} [omitFields] Fields to omit (comma-separated)
62864
- * @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
62865
- * @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
62866
- * @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
62867
- * @param {string} [groupField] Field to group results by
62868
- * @param {number} [groupSize] Number of results per group
62869
- * @param {string} [snippetPrefix] Prefix for highlighted snippets
62870
- * @param {string} [snippetSuffix] Suffix for highlighted snippets
62871
- * @param {number} [snippetTokenLimit] Maximum tokens in snippet
62872
- * @param {number} [snippetMinLen] Minimum snippet length
62873
- * @param {boolean} [includeSnippets] Include snippets in results
62874
- * @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
62875
- * @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
62876
- * @param {number} [typoMax] Maximum typo tolerance
62877
- * @param {number} [typoMinLen1] Min word length for 1 typo
62878
- * @param {number} [typoMinLen2] Min word length for 2 typos
62879
- * @param {number} [searchTimeoutMs] Search timeout in milliseconds
62880
- * @param {boolean} [requireAllTerms] Require all search terms to match
62881
- * @param {boolean} [exactMatchBoost] Boost exact matches
62882
- * @param {boolean} [cacheResults] Cache search results
62883
- * @param {boolean} [applyRules] Apply search rules
62884
- * @param {string} [presetName] Search preset name to use
62885
- * @param {string} [facetSearchText] Text to filter facet values
62789
+ * Removes store-specific words from a language word list ## 🔎 Activity Logs Generated This operation **records an Activity Log entry** with: - **Action:** update - **Resource Type:** stopword_list - **Resource ID:** xStoreID - **Description:** Includes number of words removed & details - **State Before:** `{ removed_words: [..], count: N }` - **State After:** `{ removed_words: [], count: 0 }` - **Changed Fields:** `[ \"words_removed(N)\" ]` ---
62790
+ * @summary Remove words from language word list
62791
+ * @param {string} xStoreID X-Store ID
62792
+ * @param {number} wordListID Word List ID
62793
+ * @param {DataTypesRemoveWordsFromLanguageListRequest} dataTypesRemoveWordsFromLanguageListRequest Remove words request
62886
62794
  * @param {*} [options] Override http request option.
62887
62795
  * @throws {RequiredError}
62796
+ * @memberof StopwordsApi
62888
62797
  */
62889
- 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>;
62798
+ adminStoresXStoreIDStopwordsWordlistsWordListIDWordsDelete(xStoreID: string, wordListID: number, dataTypesRemoveWordsFromLanguageListRequest: DataTypesRemoveWordsFromLanguageListRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesUpdateWordStatusResponseWrapper, any, {}>>;
62890
62799
  /**
62891
- * 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.
62892
- * @summary Search (POST)
62893
- * @param {string} xStoreid Store ID (from dashboard)
62894
- * @param {string} xStoresecret Store read secret (from dashboard)
62895
- * @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
62896
- * @param {string} [xUserId] User ID for personalization
62897
- * @param {string} [xAnonId] Anonymous user ID for personalization
62898
- * @param {string} [xSessionId] Session ID for personalization
62800
+ * Adds one or more words to a language-based stopword list for a store. Also records Activity Logs capturing before/after state and changed fields.
62801
+ * @summary Add words to language word list
62802
+ * @param {string} xStoreID X-Store ID
62803
+ * @param {number} wordListID Word List ID
62804
+ * @param {DataTypesAddWordsToLanguageListRequest} dataTypesAddWordsToLanguageListRequest Add words request
62899
62805
  * @param {*} [options] Override http request option.
62900
62806
  * @throws {RequiredError}
62807
+ * @memberof StopwordsApi
62901
62808
  */
62902
- v1SearchPost: (xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62903
- };
62809
+ adminStoresXStoreIDStopwordsWordlistsWordListIDWordsPost(xStoreID: string, wordListID: number, dataTypesAddWordsToLanguageListRequest: DataTypesAddWordsToLanguageListRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesUpdateWordStatusResponseWrapper, any, {}>>;
62810
+ }
62904
62811
  /**
62905
- * SearchApi - functional programming interface
62812
+ * StoreCreationApi - axios parameter creator
62906
62813
  * @export
62907
62814
  */
62908
- export declare const SearchApiFp: (configuration?: Configuration) => {
62815
+ export declare const StoreCreationApiAxiosParamCreator: (configuration?: Configuration) => {
62909
62816
  /**
62910
- * Search documents with combined widget and document data, autocomplete suggestions, and configurable stopwords/synonyms
62911
- * @summary Admin Search API
62912
- * @param {string} xStoreID X-Store ID
62913
- * @param {DataTypesAdminSearchRequest} dataTypesAdminSearchRequest Admin search request with optional stopword_sets and synonym_sets for granular control
62817
+ * Retrieves validation errors for a specific job ID if any invalid records were found during data upload
62818
+ * @summary Get validation errors for a job
62819
+ * @param {string} jobid Job ID
62914
62820
  * @param {*} [options] Override http request option.
62915
62821
  * @throws {RequiredError}
62916
62822
  */
62917
- adminV1SearchXStoreIDPost(xStoreID: string, dataTypesAdminSearchRequest: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesCombinedSearchResponseWrapper>>;
62823
+ adminV1StoreCreationJobstatusJobidValidationErrorsGet: (jobid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62918
62824
  /**
62919
- * Get metadata about all configurable fields for dynamic form generation
62920
- * @summary Get Configuration Schema
62921
- * @param {string} [indexname] Index name to get field options from
62825
+ * Deletes (soft delete) the current store creation progress
62826
+ * @summary Delete store creation progress
62922
62827
  * @param {*} [options] Override http request option.
62923
62828
  * @throws {RequiredError}
62924
62829
  */
62925
- v1IndexConfigSchemaGet(indexname?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>>;
62830
+ adminV1StoreCreationProgressDelete: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62926
62831
  /**
62927
- * Get the current index configuration
62928
- * @summary Get Index Config
62929
- * @param {string} indexname Index Name
62832
+ * Retrieves the current step and state of store creation for the user. This endpoint gets the most recent store creation progress. For specific store creation flows, use the path-based endpoint with xstoreid.
62833
+ * @summary Get current store creation progress
62930
62834
  * @param {*} [options] Override http request option.
62931
62835
  * @throws {RequiredError}
62932
62836
  */
62933
- v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponseWrapper>>;
62837
+ adminV1StoreCreationProgressGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62934
62838
  /**
62935
- * Configure the index for search
62936
- * @summary Index Config
62937
- * @param {string} indexname Index Name
62938
- * @param {DataTypesIndexConfig} dataTypesIndexConfig Index configuration
62839
+ * Uploads a custom schema JSON file for store data structure definition
62840
+ * @summary Upload custom schema for store
62841
+ * @param {File} file Schema JSON file
62939
62842
  * @param {*} [options] Override http request option.
62940
62843
  * @throws {RequiredError}
62941
62844
  */
62942
- v1IndexIndexnameConfigPost(indexname: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
62845
+ adminV1StoreCreationSchemaUploadPost: (file: File, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62943
62846
  /**
62944
- * Update a single property of the index configuration
62945
- * @summary Update Index Config Property
62946
- * @param {string} indexname Index Name
62947
- * @param {string} property Property name
62948
- * @param {object} body Property value
62847
+ * Updates a specific step in the store creation flow. This endpoint updates the most recent store creation progress. For specific store creation flows, use the path-based endpoint with xstoreid.
62848
+ * @summary Update store creation step
62849
+ * @param {DataTypesStoreCreationRequest} dataTypesStoreCreationRequest Store creation step data
62949
62850
  * @param {*} [options] Override http request option.
62950
62851
  * @throws {RequiredError}
62951
62852
  */
62952
- v1IndexIndexnameConfigPropertyPatch(indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
62853
+ adminV1StoreCreationStepPost: (dataTypesStoreCreationRequest: DataTypesStoreCreationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62953
62854
  /**
62954
- * Get default configuration values computed from the Typesense schema
62955
- * @summary Get Schema-Based Defaults
62956
- * @param {string} indexname Index Name
62855
+ * Retrieves validation status and results for a validation job. Poll this endpoint to check if validation is complete.
62856
+ * @summary Get validation status and results
62857
+ * @param {string} validationJobId Validation Job ID
62957
62858
  * @param {*} [options] Override http request option.
62958
62859
  * @throws {RequiredError}
62959
62860
  */
62960
- v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>>;
62861
+ adminV1StoreCreationValidationStatusValidationJobIdGet: (validationJobId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62961
62862
  /**
62962
- * 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.
62963
- * @summary Search (GET)
62964
- * @param {string} xStoreid Store ID (from dashboard)
62965
- * @param {string} xStoresecret Store read secret (from dashboard)
62966
- * @param {string} q Search query
62967
- * @param {string} [xUserId] User ID for personalization
62968
- * @param {string} [xAnonId] Anonymous user ID for personalization
62969
- * @param {string} [xSessionId] Session ID for personalization
62970
- * @param {number} [page] Page number (default: 1)
62971
- * @param {number} [perPage] Items per page (default: 10)
62972
- * @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
62973
- * @param {string} [filterBy] Filter string (e.g., category:shirts)
62974
- * @param {string} [facetBy] Facet fields (comma-separated)
62975
- * @param {number} [maxFacetValues] Maximum facet values to return
62976
- * @param {boolean} [widgetMode] Return widget-formatted results
62977
- * @param {boolean} [includeSuggestions] Include autocomplete suggestions
62978
- * @param {number} [suggestionsLimit] Number of suggestions to return
62979
- * @param {string} [analyticsTags] Analytics tags (comma-separated)
62980
- * @param {string} [stopwordSets] Stopword set IDs (comma-separated)
62981
- * @param {string} [synonymSets] Synonym set IDs (comma-separated)
62982
- * @param {string} [searchFields] Fields to search in (comma-separated)
62983
- * @param {string} [returnFields] Fields to return (comma-separated)
62984
- * @param {string} [omitFields] Fields to omit (comma-separated)
62985
- * @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
62986
- * @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
62987
- * @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
62988
- * @param {string} [groupField] Field to group results by
62989
- * @param {number} [groupSize] Number of results per group
62990
- * @param {string} [snippetPrefix] Prefix for highlighted snippets
62991
- * @param {string} [snippetSuffix] Suffix for highlighted snippets
62992
- * @param {number} [snippetTokenLimit] Maximum tokens in snippet
62993
- * @param {number} [snippetMinLen] Minimum snippet length
62994
- * @param {boolean} [includeSnippets] Include snippets in results
62995
- * @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
62996
- * @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
62997
- * @param {number} [typoMax] Maximum typo tolerance
62998
- * @param {number} [typoMinLen1] Min word length for 1 typo
62999
- * @param {number} [typoMinLen2] Min word length for 2 typos
63000
- * @param {number} [searchTimeoutMs] Search timeout in milliseconds
63001
- * @param {boolean} [requireAllTerms] Require all search terms to match
63002
- * @param {boolean} [exactMatchBoost] Boost exact matches
63003
- * @param {boolean} [cacheResults] Cache search results
63004
- * @param {boolean} [applyRules] Apply search rules
63005
- * @param {string} [presetName] Search preset name to use
63006
- * @param {string} [facetSearchText] Text to filter facet values
62863
+ * Proceeds with importing data after validation. Can import only valid records if proceedWithPartial is true.
62864
+ * @summary Proceed with import after validation
62865
+ * @param {string} xstoreid Store XStoreID
62866
+ * @param {DataTypesProceedWithImportRequest} dataTypesProceedWithImportRequest Proceed import request
63007
62867
  * @param {*} [options] Override http request option.
63008
62868
  * @throws {RequiredError}
63009
62869
  */
63010
- 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>>;
62870
+ adminV1StoreCreationXstoreidProceedImportPost: (xstoreid: string, dataTypesProceedWithImportRequest: DataTypesProceedWithImportRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63011
62871
  /**
63012
- * 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.
63013
- * @summary Search (POST)
63014
- * @param {string} xStoreid Store ID (from dashboard)
63015
- * @param {string} xStoresecret Store read secret (from dashboard)
63016
- * @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
63017
- * @param {string} [xUserId] User ID for personalization
63018
- * @param {string} [xAnonId] Anonymous user ID for personalization
63019
- * @param {string} [xSessionId] Session ID for personalization
62872
+ * Deletes (soft delete) the store creation progress for a specific store using XStoreID from path parameter
62873
+ * @summary Delete store creation progress by XStoreID
62874
+ * @param {string} xstoreid XStoreID for specific store creation flow
63020
62875
  * @param {*} [options] Override http request option.
63021
62876
  * @throws {RequiredError}
63022
62877
  */
63023
- v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOfficialSearchResponseWrapper>>;
63024
- };
63025
- /**
63026
- * SearchApi - factory interface
63027
- * @export
63028
- */
63029
- export declare const SearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
62878
+ adminV1StoreCreationXstoreidProgressDelete: (xstoreid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63030
62879
  /**
63031
- * Search documents with combined widget and document data, autocomplete suggestions, and configurable stopwords/synonyms
63032
- * @summary Admin Search API
63033
- * @param {string} xStoreID X-Store ID
63034
- * @param {DataTypesAdminSearchRequest} dataTypesAdminSearchRequest Admin search request with optional stopword_sets and synonym_sets for granular control
62880
+ * Retrieves the current step and state of store creation for a specific store using XStoreID from path parameter
62881
+ * @summary Get store creation progress by XStoreID
62882
+ * @param {string} xstoreid XStoreID for specific store creation flow
63035
62883
  * @param {*} [options] Override http request option.
63036
62884
  * @throws {RequiredError}
63037
62885
  */
63038
- adminV1SearchXStoreIDPost(xStoreID: string, dataTypesAdminSearchRequest: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesCombinedSearchResponseWrapper>;
62886
+ adminV1StoreCreationXstoreidProgressGet: (xstoreid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63039
62887
  /**
63040
- * Get metadata about all configurable fields for dynamic form generation
63041
- * @summary Get Configuration Schema
63042
- * @param {string} [indexname] Index name to get field options from
62888
+ * Updates a specific step in the store creation flow for a specific store using XStoreID from path parameter
62889
+ * @summary Update store creation step by XStoreID
62890
+ * @param {string} xstoreid XStoreID for specific store creation flow
62891
+ * @param {DataTypesStoreCreationRequest} dataTypesStoreCreationRequest Store creation step data
63043
62892
  * @param {*} [options] Override http request option.
63044
62893
  * @throws {RequiredError}
63045
62894
  */
63046
- v1IndexConfigSchemaGet(indexname?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>;
62895
+ adminV1StoreCreationXstoreidStepPost: (xstoreid: string, dataTypesStoreCreationRequest: DataTypesStoreCreationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63047
62896
  /**
63048
- * Get the current index configuration
63049
- * @summary Get Index Config
63050
- * @param {string} indexname Index Name
62897
+ * Uploads a custom JSON or CSV file for store data import
62898
+ * @summary Upload custom data file for store
62899
+ * @param {string} xstoreid Store XStoreID
62900
+ * @param {File} file Data file (JSON or CSV)
63051
62901
  * @param {*} [options] Override http request option.
63052
62902
  * @throws {RequiredError}
63053
62903
  */
63054
- v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponseWrapper>;
62904
+ adminV1StoreCreationXstoreidUploadDataPost: (xstoreid: string, file: File, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63055
62905
  /**
63056
- * Configure the index for search
63057
- * @summary Index Config
63058
- * @param {string} indexname Index Name
63059
- * @param {DataTypesIndexConfig} dataTypesIndexConfig Index configuration
62906
+ * Validates uploaded data file and returns validation results without importing. Use this to check for errors before proceeding with import.
62907
+ * @summary Validate uploaded data without importing
62908
+ * @param {string} xstoreid Store XStoreID
62909
+ * @param {File} file Data file (JSON or CSV)
63060
62910
  * @param {*} [options] Override http request option.
63061
62911
  * @throws {RequiredError}
63062
62912
  */
63063
- v1IndexIndexnameConfigPost(indexname: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
62913
+ adminV1StoreCreationXstoreidValidateDataPost: (xstoreid: string, file: File, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62914
+ };
62915
+ /**
62916
+ * StoreCreationApi - functional programming interface
62917
+ * @export
62918
+ */
62919
+ export declare const StoreCreationApiFp: (configuration?: Configuration) => {
63064
62920
  /**
63065
- * Update a single property of the index configuration
63066
- * @summary Update Index Config Property
63067
- * @param {string} indexname Index Name
63068
- * @param {string} property Property name
63069
- * @param {object} body Property value
62921
+ * Retrieves validation errors for a specific job ID if any invalid records were found during data upload
62922
+ * @summary Get validation errors for a job
62923
+ * @param {string} jobid Job ID
63070
62924
  * @param {*} [options] Override http request option.
63071
62925
  * @throws {RequiredError}
63072
62926
  */
63073
- v1IndexIndexnameConfigPropertyPatch(indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
62927
+ adminV1StoreCreationJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesValidationErrorResponse>>;
63074
62928
  /**
63075
- * Get default configuration values computed from the Typesense schema
63076
- * @summary Get Schema-Based Defaults
63077
- * @param {string} indexname Index Name
62929
+ * Deletes (soft delete) the current store creation progress
62930
+ * @summary Delete store creation progress
63078
62931
  * @param {*} [options] Override http request option.
63079
62932
  * @throws {RequiredError}
63080
62933
  */
63081
- v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>;
62934
+ adminV1StoreCreationProgressDelete(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
63082
62935
  /**
63083
- * 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.
63084
- * @summary Search (GET)
63085
- * @param {string} xStoreid Store ID (from dashboard)
63086
- * @param {string} xStoresecret Store read secret (from dashboard)
63087
- * @param {string} q Search query
63088
- * @param {string} [xUserId] User ID for personalization
63089
- * @param {string} [xAnonId] Anonymous user ID for personalization
63090
- * @param {string} [xSessionId] Session ID for personalization
63091
- * @param {number} [page] Page number (default: 1)
63092
- * @param {number} [perPage] Items per page (default: 10)
63093
- * @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
63094
- * @param {string} [filterBy] Filter string (e.g., category:shirts)
63095
- * @param {string} [facetBy] Facet fields (comma-separated)
63096
- * @param {number} [maxFacetValues] Maximum facet values to return
63097
- * @param {boolean} [widgetMode] Return widget-formatted results
63098
- * @param {boolean} [includeSuggestions] Include autocomplete suggestions
63099
- * @param {number} [suggestionsLimit] Number of suggestions to return
63100
- * @param {string} [analyticsTags] Analytics tags (comma-separated)
63101
- * @param {string} [stopwordSets] Stopword set IDs (comma-separated)
63102
- * @param {string} [synonymSets] Synonym set IDs (comma-separated)
63103
- * @param {string} [searchFields] Fields to search in (comma-separated)
63104
- * @param {string} [returnFields] Fields to return (comma-separated)
63105
- * @param {string} [omitFields] Fields to omit (comma-separated)
63106
- * @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
63107
- * @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
63108
- * @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
63109
- * @param {string} [groupField] Field to group results by
63110
- * @param {number} [groupSize] Number of results per group
63111
- * @param {string} [snippetPrefix] Prefix for highlighted snippets
63112
- * @param {string} [snippetSuffix] Suffix for highlighted snippets
63113
- * @param {number} [snippetTokenLimit] Maximum tokens in snippet
63114
- * @param {number} [snippetMinLen] Minimum snippet length
63115
- * @param {boolean} [includeSnippets] Include snippets in results
63116
- * @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
63117
- * @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
63118
- * @param {number} [typoMax] Maximum typo tolerance
63119
- * @param {number} [typoMinLen1] Min word length for 1 typo
63120
- * @param {number} [typoMinLen2] Min word length for 2 typos
63121
- * @param {number} [searchTimeoutMs] Search timeout in milliseconds
63122
- * @param {boolean} [requireAllTerms] Require all search terms to match
63123
- * @param {boolean} [exactMatchBoost] Boost exact matches
63124
- * @param {boolean} [cacheResults] Cache search results
63125
- * @param {boolean} [applyRules] Apply search rules
63126
- * @param {string} [presetName] Search preset name to use
63127
- * @param {string} [facetSearchText] Text to filter facet values
62936
+ * Retrieves the current step and state of store creation for the user. This endpoint gets the most recent store creation progress. For specific store creation flows, use the path-based endpoint with xstoreid.
62937
+ * @summary Get current store creation progress
63128
62938
  * @param {*} [options] Override http request option.
63129
62939
  * @throws {RequiredError}
63130
62940
  */
63131
- 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>;
62941
+ adminV1StoreCreationProgressGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesStoreCreationResponseWrapper>>;
63132
62942
  /**
63133
- * 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.
63134
- * @summary Search (POST)
63135
- * @param {string} xStoreid Store ID (from dashboard)
63136
- * @param {string} xStoresecret Store read secret (from dashboard)
63137
- * @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
63138
- * @param {string} [xUserId] User ID for personalization
63139
- * @param {string} [xAnonId] Anonymous user ID for personalization
63140
- * @param {string} [xSessionId] Session ID for personalization
62943
+ * Uploads a custom schema JSON file for store data structure definition
62944
+ * @summary Upload custom schema for store
62945
+ * @param {File} file Schema JSON file
63141
62946
  * @param {*} [options] Override http request option.
63142
62947
  * @throws {RequiredError}
63143
62948
  */
63144
- v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOfficialSearchResponseWrapper>;
63145
- };
63146
- /**
63147
- * SearchApi - object-oriented interface
63148
- * @export
63149
- * @class SearchApi
63150
- * @extends {BaseAPI}
63151
- */
63152
- export declare class SearchApi extends BaseAPI {
62949
+ adminV1StoreCreationSchemaUploadPost(file: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
63153
62950
  /**
63154
- * Search documents with combined widget and document data, autocomplete suggestions, and configurable stopwords/synonyms
63155
- * @summary Admin Search API
63156
- * @param {string} xStoreID X-Store ID
63157
- * @param {DataTypesAdminSearchRequest} dataTypesAdminSearchRequest Admin search request with optional stopword_sets and synonym_sets for granular control
62951
+ * Updates a specific step in the store creation flow. This endpoint updates the most recent store creation progress. For specific store creation flows, use the path-based endpoint with xstoreid.
62952
+ * @summary Update store creation step
62953
+ * @param {DataTypesStoreCreationRequest} dataTypesStoreCreationRequest Store creation step data
63158
62954
  * @param {*} [options] Override http request option.
63159
62955
  * @throws {RequiredError}
63160
- * @memberof SearchApi
63161
62956
  */
63162
- adminV1SearchXStoreIDPost(xStoreID: string, dataTypesAdminSearchRequest: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesCombinedSearchResponseWrapper, any, {}>>;
62957
+ adminV1StoreCreationStepPost(dataTypesStoreCreationRequest: DataTypesStoreCreationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesStoreCreationResponseWrapper>>;
63163
62958
  /**
63164
- * Get metadata about all configurable fields for dynamic form generation
63165
- * @summary Get Configuration Schema
63166
- * @param {string} [indexname] Index name to get field options from
62959
+ * Retrieves validation status and results for a validation job. Poll this endpoint to check if validation is complete.
62960
+ * @summary Get validation status and results
62961
+ * @param {string} validationJobId Validation Job ID
63167
62962
  * @param {*} [options] Override http request option.
63168
62963
  * @throws {RequiredError}
63169
- * @memberof SearchApi
63170
62964
  */
63171
- v1IndexConfigSchemaGet(indexname?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesConfigurationSchemaResponseWrapper, any, {}>>;
62965
+ adminV1StoreCreationValidationStatusValidationJobIdGet(validationJobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesValidationResultResponse>>;
63172
62966
  /**
63173
- * Get the current index configuration
63174
- * @summary Get Index Config
63175
- * @param {string} indexname Index Name
62967
+ * Proceeds with importing data after validation. Can import only valid records if proceedWithPartial is true.
62968
+ * @summary Proceed with import after validation
62969
+ * @param {string} xstoreid Store XStoreID
62970
+ * @param {DataTypesProceedWithImportRequest} dataTypesProceedWithImportRequest Proceed import request
63176
62971
  * @param {*} [options] Override http request option.
63177
62972
  * @throws {RequiredError}
63178
- * @memberof SearchApi
63179
62973
  */
63180
- v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesIndexConfigResponseWrapper, any, {}>>;
62974
+ adminV1StoreCreationXstoreidProceedImportPost(xstoreid: string, dataTypesProceedWithImportRequest: DataTypesProceedWithImportRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
63181
62975
  /**
63182
- * Configure the index for search
63183
- * @summary Index Config
63184
- * @param {string} indexname Index Name
63185
- * @param {DataTypesIndexConfig} dataTypesIndexConfig Index configuration
62976
+ * Deletes (soft delete) the store creation progress for a specific store using XStoreID from path parameter
62977
+ * @summary Delete store creation progress by XStoreID
62978
+ * @param {string} xstoreid XStoreID for specific store creation flow
63186
62979
  * @param {*} [options] Override http request option.
63187
62980
  * @throws {RequiredError}
63188
- * @memberof SearchApi
63189
62981
  */
63190
- v1IndexIndexnameConfigPost(indexname: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
62982
+ adminV1StoreCreationXstoreidProgressDelete(xstoreid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
63191
62983
  /**
63192
- * Update a single property of the index configuration
63193
- * @summary Update Index Config Property
63194
- * @param {string} indexname Index Name
63195
- * @param {string} property Property name
63196
- * @param {object} body Property value
62984
+ * Retrieves the current step and state of store creation for a specific store using XStoreID from path parameter
62985
+ * @summary Get store creation progress by XStoreID
62986
+ * @param {string} xstoreid XStoreID for specific store creation flow
63197
62987
  * @param {*} [options] Override http request option.
63198
62988
  * @throws {RequiredError}
63199
- * @memberof SearchApi
63200
62989
  */
63201
- v1IndexIndexnameConfigPropertyPatch(indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
62990
+ adminV1StoreCreationXstoreidProgressGet(xstoreid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesStoreCreationResponseWrapper>>;
63202
62991
  /**
63203
- * Get default configuration values computed from the Typesense schema
63204
- * @summary Get Schema-Based Defaults
63205
- * @param {string} indexname Index Name
62992
+ * Updates a specific step in the store creation flow for a specific store using XStoreID from path parameter
62993
+ * @summary Update store creation step by XStoreID
62994
+ * @param {string} xstoreid XStoreID for specific store creation flow
62995
+ * @param {DataTypesStoreCreationRequest} dataTypesStoreCreationRequest Store creation step data
63206
62996
  * @param {*} [options] Override http request option.
63207
62997
  * @throws {RequiredError}
63208
- * @memberof SearchApi
63209
62998
  */
63210
- v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaBasedDefaultsResponseWrapper, any, {}>>;
62999
+ adminV1StoreCreationXstoreidStepPost(xstoreid: string, dataTypesStoreCreationRequest: DataTypesStoreCreationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesStoreCreationResponseWrapper>>;
63211
63000
  /**
63212
- * 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.
63213
- * @summary Search (GET)
63214
- * @param {string} xStoreid Store ID (from dashboard)
63215
- * @param {string} xStoresecret Store read secret (from dashboard)
63216
- * @param {string} q Search query
63217
- * @param {string} [xUserId] User ID for personalization
63218
- * @param {string} [xAnonId] Anonymous user ID for personalization
63219
- * @param {string} [xSessionId] Session ID for personalization
63220
- * @param {number} [page] Page number (default: 1)
63221
- * @param {number} [perPage] Items per page (default: 10)
63222
- * @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
63223
- * @param {string} [filterBy] Filter string (e.g., category:shirts)
63224
- * @param {string} [facetBy] Facet fields (comma-separated)
63225
- * @param {number} [maxFacetValues] Maximum facet values to return
63226
- * @param {boolean} [widgetMode] Return widget-formatted results
63227
- * @param {boolean} [includeSuggestions] Include autocomplete suggestions
63228
- * @param {number} [suggestionsLimit] Number of suggestions to return
63229
- * @param {string} [analyticsTags] Analytics tags (comma-separated)
63230
- * @param {string} [stopwordSets] Stopword set IDs (comma-separated)
63231
- * @param {string} [synonymSets] Synonym set IDs (comma-separated)
63232
- * @param {string} [searchFields] Fields to search in (comma-separated)
63233
- * @param {string} [returnFields] Fields to return (comma-separated)
63234
- * @param {string} [omitFields] Fields to omit (comma-separated)
63235
- * @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
63236
- * @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
63237
- * @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
63238
- * @param {string} [groupField] Field to group results by
63239
- * @param {number} [groupSize] Number of results per group
63240
- * @param {string} [snippetPrefix] Prefix for highlighted snippets
63241
- * @param {string} [snippetSuffix] Suffix for highlighted snippets
63242
- * @param {number} [snippetTokenLimit] Maximum tokens in snippet
63243
- * @param {number} [snippetMinLen] Minimum snippet length
63244
- * @param {boolean} [includeSnippets] Include snippets in results
63245
- * @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
63246
- * @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
63247
- * @param {number} [typoMax] Maximum typo tolerance
63248
- * @param {number} [typoMinLen1] Min word length for 1 typo
63249
- * @param {number} [typoMinLen2] Min word length for 2 typos
63250
- * @param {number} [searchTimeoutMs] Search timeout in milliseconds
63251
- * @param {boolean} [requireAllTerms] Require all search terms to match
63252
- * @param {boolean} [exactMatchBoost] Boost exact matches
63253
- * @param {boolean} [cacheResults] Cache search results
63254
- * @param {boolean} [applyRules] Apply search rules
63255
- * @param {string} [presetName] Search preset name to use
63256
- * @param {string} [facetSearchText] Text to filter facet values
63001
+ * Uploads a custom JSON or CSV file for store data import
63002
+ * @summary Upload custom data file for store
63003
+ * @param {string} xstoreid Store XStoreID
63004
+ * @param {File} file Data file (JSON or CSV)
63257
63005
  * @param {*} [options] Override http request option.
63258
63006
  * @throws {RequiredError}
63259
- * @memberof SearchApi
63260
63007
  */
63261
- v1SearchGet(xStoreid: string, xStoresecret: string, q: string, xUserId?: string, xAnonId?: string, xSessionId?: string, page?: number, perPage?: number, sortBy?: string, filterBy?: string, facetBy?: string, maxFacetValues?: number, widgetMode?: boolean, includeSuggestions?: boolean, suggestionsLimit?: number, analyticsTags?: string, stopwordSets?: string, synonymSets?: string, searchFields?: string, returnFields?: string, omitFields?: string, snippetFields?: string, fullSnippetFields?: string, fieldWeights?: string, groupField?: string, groupSize?: number, snippetPrefix?: string, snippetSuffix?: string, snippetTokenLimit?: number, snippetMinLen?: number, includeSnippets?: boolean, prefixMode?: string, infixMode?: string, typoMax?: number, typoMinLen1?: number, typoMinLen2?: number, searchTimeoutMs?: number, requireAllTerms?: boolean, exactMatchBoost?: boolean, cacheResults?: boolean, applyRules?: boolean, presetName?: string, facetSearchText?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOfficialSearchResponseWrapper, any, {}>>;
63008
+ adminV1StoreCreationXstoreidUploadDataPost(xstoreid: string, file: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
63262
63009
  /**
63263
- * 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.
63264
- * @summary Search (POST)
63265
- * @param {string} xStoreid Store ID (from dashboard)
63266
- * @param {string} xStoresecret Store read secret (from dashboard)
63267
- * @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
63268
- * @param {string} [xUserId] User ID for personalization
63269
- * @param {string} [xAnonId] Anonymous user ID for personalization
63270
- * @param {string} [xSessionId] Session ID for personalization
63010
+ * Validates uploaded data file and returns validation results without importing. Use this to check for errors before proceeding with import.
63011
+ * @summary Validate uploaded data without importing
63012
+ * @param {string} xstoreid Store XStoreID
63013
+ * @param {File} file Data file (JSON or CSV)
63271
63014
  * @param {*} [options] Override http request option.
63272
63015
  * @throws {RequiredError}
63273
- * @memberof SearchApi
63274
63016
  */
63275
- v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOfficialSearchResponseWrapper, any, {}>>;
63276
- }
63017
+ adminV1StoreCreationXstoreidValidateDataPost(xstoreid: string, file: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
63018
+ };
63277
63019
  /**
63278
- * StopwordsApi - axios parameter creator
63020
+ * StoreCreationApi - factory interface
63279
63021
  * @export
63280
63022
  */
63281
- export declare const StopwordsApiAxiosParamCreator: (configuration?: Configuration) => {
63023
+ export declare const StoreCreationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
63282
63024
  /**
63283
- * Fetches available languages/locales with pagination
63284
- * @summary Get available languages
63285
- * @param {string} [type] Type filter (stopwords, synonyms)
63286
- * @param {number} [page] Page number (default: 1)
63287
- * @param {number} [limit] Items per page (default: 10)
63025
+ * Retrieves validation errors for a specific job ID if any invalid records were found during data upload
63026
+ * @summary Get validation errors for a job
63027
+ * @param {string} jobid Job ID
63288
63028
  * @param {*} [options] Override http request option.
63289
63029
  * @throws {RequiredError}
63290
63030
  */
63291
- adminStoresStopwordsLanguagesGet: (type?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63031
+ adminV1StoreCreationJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesValidationErrorResponse>;
63292
63032
  /**
63293
- * Enables or disables a specific word for a store. Supports default words, store-specific words, and custom words.
63294
- * @summary Update word status for store
63295
- * @param {string} xStoreID X-Store ID
63296
- * @param {DataTypesUpdateWordStatusRequest} dataTypesUpdateWordStatusRequest Word status update request. Use wordid for default words, store_language_wordid for store-specific words, or custom_wordid for custom words. Set word_type accordingly.
63033
+ * Deletes (soft delete) the current store creation progress
63034
+ * @summary Delete store creation progress
63297
63035
  * @param {*} [options] Override http request option.
63298
63036
  * @throws {RequiredError}
63299
63037
  */
63300
- adminStoresXStoreIDStopwordsWordStatusPut: (xStoreID: string, dataTypesUpdateWordStatusRequest: DataTypesUpdateWordStatusRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63038
+ adminV1StoreCreationProgressDelete(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
63301
63039
  /**
63302
- * Fetches a single word list by language with pagination on words within the wordlist
63303
- * @summary Get word lists by language
63304
- * @param {string} xStoreID X-Store ID
63305
- * @param {string} [lang] Language locale filter (e.g. \&#39;en\&#39;, \&#39;ar\&#39;)
63306
- * @param {string} [type] Type filter (stopwords, synonyms)
63307
- * @param {number} [page] Page number (default: 1)
63308
- * @param {number} [limit] Items per page (default: 10)
63040
+ * Retrieves the current step and state of store creation for the user. This endpoint gets the most recent store creation progress. For specific store creation flows, use the path-based endpoint with xstoreid.
63041
+ * @summary Get current store creation progress
63309
63042
  * @param {*} [options] Override http request option.
63310
63043
  * @throws {RequiredError}
63311
63044
  */
63312
- adminStoresXStoreIDStopwordsWordlistsGet: (xStoreID: string, lang?: string, type?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63045
+ adminV1StoreCreationProgressGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesStoreCreationResponseWrapper>;
63313
63046
  /**
63314
- * Fetches a single word list by language with pagination on words, including store-specific enabled/disabled status and store-specific added words. Supports search functionality.
63315
- * @summary Get word lists by language (includes store-specific words)
63316
- * @param {string} xStoreID X-Store ID
63317
- * @param {string} [lang] Language locale filter (e.g. \&#39;en\&#39;, \&#39;ar\&#39;)
63318
- * @param {string} [type] Type filter (stopwords, synonyms)
63319
- * @param {string} [q] Search query to filter words (case-insensitive)
63320
- * @param {number} [page] Page number (default: 1)
63321
- * @param {number} [limit] Items per page (default: 10)
63047
+ * Uploads a custom schema JSON file for store data structure definition
63048
+ * @summary Upload custom schema for store
63049
+ * @param {File} file Schema JSON file
63322
63050
  * @param {*} [options] Override http request option.
63323
63051
  * @throws {RequiredError}
63324
63052
  */
63325
- adminStoresXStoreIDStopwordsWordlistsWithStoreWordsGet: (xStoreID: string, lang?: string, type?: string, q?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63053
+ adminV1StoreCreationSchemaUploadPost(file: File, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
63326
63054
  /**
63327
- * Removes store-specific words from a language word list ## 🔎 Activity Logs Generated This operation **records an Activity Log entry** with: - **Action:** update - **Resource Type:** stopword_list - **Resource ID:** xStoreID - **Description:** Includes number of words removed & details - **State Before:** `{ removed_words: [..], count: N }` - **State After:** `{ removed_words: [], count: 0 }` - **Changed Fields:** `[ \"words_removed(N)\" ]` ---
63328
- * @summary Remove words from language word list
63329
- * @param {string} xStoreID X-Store ID
63330
- * @param {number} wordListID Word List ID
63331
- * @param {DataTypesRemoveWordsFromLanguageListRequest} dataTypesRemoveWordsFromLanguageListRequest Remove words request
63055
+ * Updates a specific step in the store creation flow. This endpoint updates the most recent store creation progress. For specific store creation flows, use the path-based endpoint with xstoreid.
63056
+ * @summary Update store creation step
63057
+ * @param {DataTypesStoreCreationRequest} dataTypesStoreCreationRequest Store creation step data
63332
63058
  * @param {*} [options] Override http request option.
63333
63059
  * @throws {RequiredError}
63334
63060
  */
63335
- adminStoresXStoreIDStopwordsWordlistsWordListIDWordsDelete: (xStoreID: string, wordListID: number, dataTypesRemoveWordsFromLanguageListRequest: DataTypesRemoveWordsFromLanguageListRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63061
+ adminV1StoreCreationStepPost(dataTypesStoreCreationRequest: DataTypesStoreCreationRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesStoreCreationResponseWrapper>;
63336
63062
  /**
63337
- * Adds one or more words to a language-based stopword list for a store. Also records Activity Logs capturing before/after state and changed fields.
63338
- * @summary Add words to language word list
63339
- * @param {string} xStoreID X-Store ID
63340
- * @param {number} wordListID Word List ID
63341
- * @param {DataTypesAddWordsToLanguageListRequest} dataTypesAddWordsToLanguageListRequest Add words request
63063
+ * Retrieves validation status and results for a validation job. Poll this endpoint to check if validation is complete.
63064
+ * @summary Get validation status and results
63065
+ * @param {string} validationJobId Validation Job ID
63342
63066
  * @param {*} [options] Override http request option.
63343
63067
  * @throws {RequiredError}
63344
63068
  */
63345
- adminStoresXStoreIDStopwordsWordlistsWordListIDWordsPost: (xStoreID: string, wordListID: number, dataTypesAddWordsToLanguageListRequest: DataTypesAddWordsToLanguageListRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63346
- };
63347
- /**
63348
- * StopwordsApi - functional programming interface
63349
- * @export
63350
- */
63351
- export declare const StopwordsApiFp: (configuration?: Configuration) => {
63069
+ adminV1StoreCreationValidationStatusValidationJobIdGet(validationJobId: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesValidationResultResponse>;
63352
63070
  /**
63353
- * Fetches available languages/locales with pagination
63354
- * @summary Get available languages
63355
- * @param {string} [type] Type filter (stopwords, synonyms)
63356
- * @param {number} [page] Page number (default: 1)
63357
- * @param {number} [limit] Items per page (default: 10)
63071
+ * Proceeds with importing data after validation. Can import only valid records if proceedWithPartial is true.
63072
+ * @summary Proceed with import after validation
63073
+ * @param {string} xstoreid Store XStoreID
63074
+ * @param {DataTypesProceedWithImportRequest} dataTypesProceedWithImportRequest Proceed import request
63358
63075
  * @param {*} [options] Override http request option.
63359
63076
  * @throws {RequiredError}
63360
63077
  */
63361
- adminStoresStopwordsLanguagesGet(type?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesLanguagesResponseWrapper>>;
63078
+ adminV1StoreCreationXstoreidProceedImportPost(xstoreid: string, dataTypesProceedWithImportRequest: DataTypesProceedWithImportRequest, options?: RawAxiosRequestConfig): AxiosPromise<object>;
63362
63079
  /**
63363
- * Enables or disables a specific word for a store. Supports default words, store-specific words, and custom words.
63364
- * @summary Update word status for store
63365
- * @param {string} xStoreID X-Store ID
63366
- * @param {DataTypesUpdateWordStatusRequest} dataTypesUpdateWordStatusRequest Word status update request. Use wordid for default words, store_language_wordid for store-specific words, or custom_wordid for custom words. Set word_type accordingly.
63080
+ * Deletes (soft delete) the store creation progress for a specific store using XStoreID from path parameter
63081
+ * @summary Delete store creation progress by XStoreID
63082
+ * @param {string} xstoreid XStoreID for specific store creation flow
63367
63083
  * @param {*} [options] Override http request option.
63368
63084
  * @throws {RequiredError}
63369
63085
  */
63370
- adminStoresXStoreIDStopwordsWordStatusPut(xStoreID: string, dataTypesUpdateWordStatusRequest: DataTypesUpdateWordStatusRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesUpdateWordStatusResponseWrapper>>;
63086
+ adminV1StoreCreationXstoreidProgressDelete(xstoreid: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
63371
63087
  /**
63372
- * Fetches a single word list by language with pagination on words within the wordlist
63373
- * @summary Get word lists by language
63374
- * @param {string} xStoreID X-Store ID
63375
- * @param {string} [lang] Language locale filter (e.g. \&#39;en\&#39;, \&#39;ar\&#39;)
63376
- * @param {string} [type] Type filter (stopwords, synonyms)
63377
- * @param {number} [page] Page number (default: 1)
63378
- * @param {number} [limit] Items per page (default: 10)
63088
+ * Retrieves the current step and state of store creation for a specific store using XStoreID from path parameter
63089
+ * @summary Get store creation progress by XStoreID
63090
+ * @param {string} xstoreid XStoreID for specific store creation flow
63379
63091
  * @param {*} [options] Override http request option.
63380
63092
  * @throws {RequiredError}
63381
63093
  */
63382
- adminStoresXStoreIDStopwordsWordlistsGet(xStoreID: string, lang?: string, type?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesWordListResponseWrapper>>;
63094
+ adminV1StoreCreationXstoreidProgressGet(xstoreid: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesStoreCreationResponseWrapper>;
63383
63095
  /**
63384
- * Fetches a single word list by language with pagination on words, including store-specific enabled/disabled status and store-specific added words. Supports search functionality.
63385
- * @summary Get word lists by language (includes store-specific words)
63386
- * @param {string} xStoreID X-Store ID
63387
- * @param {string} [lang] Language locale filter (e.g. \&#39;en\&#39;, \&#39;ar\&#39;)
63388
- * @param {string} [type] Type filter (stopwords, synonyms)
63389
- * @param {string} [q] Search query to filter words (case-insensitive)
63390
- * @param {number} [page] Page number (default: 1)
63391
- * @param {number} [limit] Items per page (default: 10)
63096
+ * Updates a specific step in the store creation flow for a specific store using XStoreID from path parameter
63097
+ * @summary Update store creation step by XStoreID
63098
+ * @param {string} xstoreid XStoreID for specific store creation flow
63099
+ * @param {DataTypesStoreCreationRequest} dataTypesStoreCreationRequest Store creation step data
63392
63100
  * @param {*} [options] Override http request option.
63393
63101
  * @throws {RequiredError}
63394
63102
  */
63395
- adminStoresXStoreIDStopwordsWordlistsWithStoreWordsGet(xStoreID: string, lang?: string, type?: string, q?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesWordListResponseEnhancedWrapper>>;
63103
+ adminV1StoreCreationXstoreidStepPost(xstoreid: string, dataTypesStoreCreationRequest: DataTypesStoreCreationRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesStoreCreationResponseWrapper>;
63396
63104
  /**
63397
- * Removes store-specific words from a language word list ## 🔎 Activity Logs Generated This operation **records an Activity Log entry** with: - **Action:** update - **Resource Type:** stopword_list - **Resource ID:** xStoreID - **Description:** Includes number of words removed & details - **State Before:** `{ removed_words: [..], count: N }` - **State After:** `{ removed_words: [], count: 0 }` - **Changed Fields:** `[ \"words_removed(N)\" ]` ---
63398
- * @summary Remove words from language word list
63399
- * @param {string} xStoreID X-Store ID
63400
- * @param {number} wordListID Word List ID
63401
- * @param {DataTypesRemoveWordsFromLanguageListRequest} dataTypesRemoveWordsFromLanguageListRequest Remove words request
63105
+ * Uploads a custom JSON or CSV file for store data import
63106
+ * @summary Upload custom data file for store
63107
+ * @param {string} xstoreid Store XStoreID
63108
+ * @param {File} file Data file (JSON or CSV)
63402
63109
  * @param {*} [options] Override http request option.
63403
63110
  * @throws {RequiredError}
63404
63111
  */
63405
- adminStoresXStoreIDStopwordsWordlistsWordListIDWordsDelete(xStoreID: string, wordListID: number, dataTypesRemoveWordsFromLanguageListRequest: DataTypesRemoveWordsFromLanguageListRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesUpdateWordStatusResponseWrapper>>;
63112
+ adminV1StoreCreationXstoreidUploadDataPost(xstoreid: string, file: File, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
63406
63113
  /**
63407
- * Adds one or more words to a language-based stopword list for a store. Also records Activity Logs capturing before/after state and changed fields.
63408
- * @summary Add words to language word list
63409
- * @param {string} xStoreID X-Store ID
63410
- * @param {number} wordListID Word List ID
63411
- * @param {DataTypesAddWordsToLanguageListRequest} dataTypesAddWordsToLanguageListRequest Add words request
63114
+ * Validates uploaded data file and returns validation results without importing. Use this to check for errors before proceeding with import.
63115
+ * @summary Validate uploaded data without importing
63116
+ * @param {string} xstoreid Store XStoreID
63117
+ * @param {File} file Data file (JSON or CSV)
63412
63118
  * @param {*} [options] Override http request option.
63413
63119
  * @throws {RequiredError}
63414
63120
  */
63415
- adminStoresXStoreIDStopwordsWordlistsWordListIDWordsPost(xStoreID: string, wordListID: number, dataTypesAddWordsToLanguageListRequest: DataTypesAddWordsToLanguageListRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesUpdateWordStatusResponseWrapper>>;
63121
+ adminV1StoreCreationXstoreidValidateDataPost(xstoreid: string, file: File, options?: RawAxiosRequestConfig): AxiosPromise<object>;
63416
63122
  };
63417
63123
  /**
63418
- * StopwordsApi - factory interface
63124
+ * StoreCreationApi - object-oriented interface
63419
63125
  * @export
63126
+ * @class StoreCreationApi
63127
+ * @extends {BaseAPI}
63420
63128
  */
63421
- export declare const StopwordsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
63129
+ export declare class StoreCreationApi extends BaseAPI {
63422
63130
  /**
63423
- * Fetches available languages/locales with pagination
63424
- * @summary Get available languages
63425
- * @param {string} [type] Type filter (stopwords, synonyms)
63426
- * @param {number} [page] Page number (default: 1)
63427
- * @param {number} [limit] Items per page (default: 10)
63131
+ * Retrieves validation errors for a specific job ID if any invalid records were found during data upload
63132
+ * @summary Get validation errors for a job
63133
+ * @param {string} jobid Job ID
63428
63134
  * @param {*} [options] Override http request option.
63429
63135
  * @throws {RequiredError}
63136
+ * @memberof StoreCreationApi
63430
63137
  */
63431
- adminStoresStopwordsLanguagesGet(type?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesLanguagesResponseWrapper>;
63138
+ adminV1StoreCreationJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesValidationErrorResponse, any, {}>>;
63432
63139
  /**
63433
- * Enables or disables a specific word for a store. Supports default words, store-specific words, and custom words.
63434
- * @summary Update word status for store
63435
- * @param {string} xStoreID X-Store ID
63436
- * @param {DataTypesUpdateWordStatusRequest} dataTypesUpdateWordStatusRequest Word status update request. Use wordid for default words, store_language_wordid for store-specific words, or custom_wordid for custom words. Set word_type accordingly.
63140
+ * Deletes (soft delete) the current store creation progress
63141
+ * @summary Delete store creation progress
63437
63142
  * @param {*} [options] Override http request option.
63438
63143
  * @throws {RequiredError}
63144
+ * @memberof StoreCreationApi
63439
63145
  */
63440
- adminStoresXStoreIDStopwordsWordStatusPut(xStoreID: string, dataTypesUpdateWordStatusRequest: DataTypesUpdateWordStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesUpdateWordStatusResponseWrapper>;
63146
+ adminV1StoreCreationProgressDelete(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
63441
63147
  /**
63442
- * Fetches a single word list by language with pagination on words within the wordlist
63443
- * @summary Get word lists by language
63444
- * @param {string} xStoreID X-Store ID
63445
- * @param {string} [lang] Language locale filter (e.g. \&#39;en\&#39;, \&#39;ar\&#39;)
63446
- * @param {string} [type] Type filter (stopwords, synonyms)
63447
- * @param {number} [page] Page number (default: 1)
63448
- * @param {number} [limit] Items per page (default: 10)
63148
+ * Retrieves the current step and state of store creation for the user. This endpoint gets the most recent store creation progress. For specific store creation flows, use the path-based endpoint with xstoreid.
63149
+ * @summary Get current store creation progress
63449
63150
  * @param {*} [options] Override http request option.
63450
63151
  * @throws {RequiredError}
63152
+ * @memberof StoreCreationApi
63451
63153
  */
63452
- adminStoresXStoreIDStopwordsWordlistsGet(xStoreID: string, lang?: string, type?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesWordListResponseWrapper>;
63154
+ adminV1StoreCreationProgressGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesStoreCreationResponseWrapper, any, {}>>;
63155
+ /**
63156
+ * Uploads a custom schema JSON file for store data structure definition
63157
+ * @summary Upload custom schema for store
63158
+ * @param {File} file Schema JSON file
63159
+ * @param {*} [options] Override http request option.
63160
+ * @throws {RequiredError}
63161
+ * @memberof StoreCreationApi
63162
+ */
63163
+ adminV1StoreCreationSchemaUploadPost(file: File, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
63164
+ /**
63165
+ * Updates a specific step in the store creation flow. This endpoint updates the most recent store creation progress. For specific store creation flows, use the path-based endpoint with xstoreid.
63166
+ * @summary Update store creation step
63167
+ * @param {DataTypesStoreCreationRequest} dataTypesStoreCreationRequest Store creation step data
63168
+ * @param {*} [options] Override http request option.
63169
+ * @throws {RequiredError}
63170
+ * @memberof StoreCreationApi
63171
+ */
63172
+ adminV1StoreCreationStepPost(dataTypesStoreCreationRequest: DataTypesStoreCreationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesStoreCreationResponseWrapper, any, {}>>;
63173
+ /**
63174
+ * Retrieves validation status and results for a validation job. Poll this endpoint to check if validation is complete.
63175
+ * @summary Get validation status and results
63176
+ * @param {string} validationJobId Validation Job ID
63177
+ * @param {*} [options] Override http request option.
63178
+ * @throws {RequiredError}
63179
+ * @memberof StoreCreationApi
63180
+ */
63181
+ adminV1StoreCreationValidationStatusValidationJobIdGet(validationJobId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesValidationResultResponse, any, {}>>;
63182
+ /**
63183
+ * Proceeds with importing data after validation. Can import only valid records if proceedWithPartial is true.
63184
+ * @summary Proceed with import after validation
63185
+ * @param {string} xstoreid Store XStoreID
63186
+ * @param {DataTypesProceedWithImportRequest} dataTypesProceedWithImportRequest Proceed import request
63187
+ * @param {*} [options] Override http request option.
63188
+ * @throws {RequiredError}
63189
+ * @memberof StoreCreationApi
63190
+ */
63191
+ adminV1StoreCreationXstoreidProceedImportPost(xstoreid: string, dataTypesProceedWithImportRequest: DataTypesProceedWithImportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
63192
+ /**
63193
+ * Deletes (soft delete) the store creation progress for a specific store using XStoreID from path parameter
63194
+ * @summary Delete store creation progress by XStoreID
63195
+ * @param {string} xstoreid XStoreID for specific store creation flow
63196
+ * @param {*} [options] Override http request option.
63197
+ * @throws {RequiredError}
63198
+ * @memberof StoreCreationApi
63199
+ */
63200
+ adminV1StoreCreationXstoreidProgressDelete(xstoreid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
63201
+ /**
63202
+ * Retrieves the current step and state of store creation for a specific store using XStoreID from path parameter
63203
+ * @summary Get store creation progress by XStoreID
63204
+ * @param {string} xstoreid XStoreID for specific store creation flow
63205
+ * @param {*} [options] Override http request option.
63206
+ * @throws {RequiredError}
63207
+ * @memberof StoreCreationApi
63208
+ */
63209
+ adminV1StoreCreationXstoreidProgressGet(xstoreid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesStoreCreationResponseWrapper, any, {}>>;
63453
63210
  /**
63454
- * Fetches a single word list by language with pagination on words, including store-specific enabled/disabled status and store-specific added words. Supports search functionality.
63455
- * @summary Get word lists by language (includes store-specific words)
63456
- * @param {string} xStoreID X-Store ID
63457
- * @param {string} [lang] Language locale filter (e.g. \&#39;en\&#39;, \&#39;ar\&#39;)
63458
- * @param {string} [type] Type filter (stopwords, synonyms)
63459
- * @param {string} [q] Search query to filter words (case-insensitive)
63460
- * @param {number} [page] Page number (default: 1)
63461
- * @param {number} [limit] Items per page (default: 10)
63211
+ * Updates a specific step in the store creation flow for a specific store using XStoreID from path parameter
63212
+ * @summary Update store creation step by XStoreID
63213
+ * @param {string} xstoreid XStoreID for specific store creation flow
63214
+ * @param {DataTypesStoreCreationRequest} dataTypesStoreCreationRequest Store creation step data
63462
63215
  * @param {*} [options] Override http request option.
63463
63216
  * @throws {RequiredError}
63217
+ * @memberof StoreCreationApi
63464
63218
  */
63465
- adminStoresXStoreIDStopwordsWordlistsWithStoreWordsGet(xStoreID: string, lang?: string, type?: string, q?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesWordListResponseEnhancedWrapper>;
63219
+ adminV1StoreCreationXstoreidStepPost(xstoreid: string, dataTypesStoreCreationRequest: DataTypesStoreCreationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesStoreCreationResponseWrapper, any, {}>>;
63466
63220
  /**
63467
- * Removes store-specific words from a language word list ## 🔎 Activity Logs Generated This operation **records an Activity Log entry** with: - **Action:** update - **Resource Type:** stopword_list - **Resource ID:** xStoreID - **Description:** Includes number of words removed & details - **State Before:** `{ removed_words: [..], count: N }` - **State After:** `{ removed_words: [], count: 0 }` - **Changed Fields:** `[ \"words_removed(N)\" ]` ---
63468
- * @summary Remove words from language word list
63469
- * @param {string} xStoreID X-Store ID
63470
- * @param {number} wordListID Word List ID
63471
- * @param {DataTypesRemoveWordsFromLanguageListRequest} dataTypesRemoveWordsFromLanguageListRequest Remove words request
63221
+ * Uploads a custom JSON or CSV file for store data import
63222
+ * @summary Upload custom data file for store
63223
+ * @param {string} xstoreid Store XStoreID
63224
+ * @param {File} file Data file (JSON or CSV)
63472
63225
  * @param {*} [options] Override http request option.
63473
63226
  * @throws {RequiredError}
63227
+ * @memberof StoreCreationApi
63474
63228
  */
63475
- adminStoresXStoreIDStopwordsWordlistsWordListIDWordsDelete(xStoreID: string, wordListID: number, dataTypesRemoveWordsFromLanguageListRequest: DataTypesRemoveWordsFromLanguageListRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesUpdateWordStatusResponseWrapper>;
63229
+ adminV1StoreCreationXstoreidUploadDataPost(xstoreid: string, file: File, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
63476
63230
  /**
63477
- * Adds one or more words to a language-based stopword list for a store. Also records Activity Logs capturing before/after state and changed fields.
63478
- * @summary Add words to language word list
63479
- * @param {string} xStoreID X-Store ID
63480
- * @param {number} wordListID Word List ID
63481
- * @param {DataTypesAddWordsToLanguageListRequest} dataTypesAddWordsToLanguageListRequest Add words request
63231
+ * Validates uploaded data file and returns validation results without importing. Use this to check for errors before proceeding with import.
63232
+ * @summary Validate uploaded data without importing
63233
+ * @param {string} xstoreid Store XStoreID
63234
+ * @param {File} file Data file (JSON or CSV)
63482
63235
  * @param {*} [options] Override http request option.
63483
63236
  * @throws {RequiredError}
63237
+ * @memberof StoreCreationApi
63484
63238
  */
63485
- adminStoresXStoreIDStopwordsWordlistsWordListIDWordsPost(xStoreID: string, wordListID: number, dataTypesAddWordsToLanguageListRequest: DataTypesAddWordsToLanguageListRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesUpdateWordStatusResponseWrapper>;
63486
- };
63239
+ adminV1StoreCreationXstoreidValidateDataPost(xstoreid: string, file: File, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
63240
+ }
63487
63241
  /**
63488
- * StopwordsApi - object-oriented interface
63242
+ * StoreDocumentsApi - axios parameter creator
63489
63243
  * @export
63490
- * @class StopwordsApi
63491
- * @extends {BaseAPI}
63492
63244
  */
63493
- export declare class StopwordsApi extends BaseAPI {
63245
+ export declare const StoreDocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
63494
63246
  /**
63495
- * Fetches available languages/locales with pagination
63496
- * @summary Get available languages
63497
- * @param {string} [type] Type filter (stopwords, synonyms)
63498
- * @param {number} [page] Page number (default: 1)
63499
- * @param {number} [limit] Items per page (default: 10)
63247
+ *
63248
+ * @summary Bulk document operations
63249
+ * @param {string} xStoreID X-Store ID
63250
+ * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest Bulk operation data
63500
63251
  * @param {*} [options] Override http request option.
63501
63252
  * @throws {RequiredError}
63502
- * @memberof StopwordsApi
63503
63253
  */
63504
- adminStoresStopwordsLanguagesGet(type?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesLanguagesResponseWrapper, any, {}>>;
63254
+ adminStoresXStoreIDDocumentsBulkPost: (xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63505
63255
  /**
63506
- * Enables or disables a specific word for a store. Supports default words, store-specific words, and custom words.
63507
- * @summary Update word status for store
63256
+ * Deletes a document by ID from a store
63257
+ * @summary Delete document
63508
63258
  * @param {string} xStoreID X-Store ID
63509
- * @param {DataTypesUpdateWordStatusRequest} dataTypesUpdateWordStatusRequest Word status update request. Use wordid for default words, store_language_wordid for store-specific words, or custom_wordid for custom words. Set word_type accordingly.
63259
+ * @param {string} documentID Document ID
63510
63260
  * @param {*} [options] Override http request option.
63511
63261
  * @throws {RequiredError}
63512
- * @memberof StopwordsApi
63513
63262
  */
63514
- adminStoresXStoreIDStopwordsWordStatusPut(xStoreID: string, dataTypesUpdateWordStatusRequest: DataTypesUpdateWordStatusRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesUpdateWordStatusResponseWrapper, any, {}>>;
63263
+ adminStoresXStoreIDDocumentsDocumentIDDelete: (xStoreID: string, documentID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63515
63264
  /**
63516
- * Fetches a single word list by language with pagination on words within the wordlist
63517
- * @summary Get word lists by language
63265
+ * Retrieves a single document by ID from a store
63266
+ * @summary Get single document
63518
63267
  * @param {string} xStoreID X-Store ID
63519
- * @param {string} [lang] Language locale filter (e.g. \&#39;en\&#39;, \&#39;ar\&#39;)
63520
- * @param {string} [type] Type filter (stopwords, synonyms)
63521
- * @param {number} [page] Page number (default: 1)
63522
- * @param {number} [limit] Items per page (default: 10)
63268
+ * @param {string} documentID Document ID
63523
63269
  * @param {*} [options] Override http request option.
63524
63270
  * @throws {RequiredError}
63525
- * @memberof StopwordsApi
63526
63271
  */
63527
- adminStoresXStoreIDStopwordsWordlistsGet(xStoreID: string, lang?: string, type?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesWordListResponseWrapper, any, {}>>;
63272
+ adminStoresXStoreIDDocumentsDocumentIDGet: (xStoreID: string, documentID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63528
63273
  /**
63529
- * Fetches a single word list by language with pagination on words, including store-specific enabled/disabled status and store-specific added words. Supports search functionality.
63530
- * @summary Get word lists by language (includes store-specific words)
63274
+ *
63275
+ * @summary Update document
63531
63276
  * @param {string} xStoreID X-Store ID
63532
- * @param {string} [lang] Language locale filter (e.g. \&#39;en\&#39;, \&#39;ar\&#39;)
63533
- * @param {string} [type] Type filter (stopwords, synonyms)
63534
- * @param {string} [q] Search query to filter words (case-insensitive)
63535
- * @param {number} [page] Page number (default: 1)
63536
- * @param {number} [limit] Items per page (default: 10)
63277
+ * @param {string} documentID Document ID
63278
+ * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
63537
63279
  * @param {*} [options] Override http request option.
63538
63280
  * @throws {RequiredError}
63539
- * @memberof StopwordsApi
63540
63281
  */
63541
- adminStoresXStoreIDStopwordsWordlistsWithStoreWordsGet(xStoreID: string, lang?: string, type?: string, q?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesWordListResponseEnhancedWrapper, any, {}>>;
63282
+ adminStoresXStoreIDDocumentsDocumentIDPut: (xStoreID: string, documentID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63542
63283
  /**
63543
- * Removes store-specific words from a language word list ## 🔎 Activity Logs Generated This operation **records an Activity Log entry** with: - **Action:** update - **Resource Type:** stopword_list - **Resource ID:** xStoreID - **Description:** Includes number of words removed & details - **State Before:** `{ removed_words: [..], count: N }` - **State After:** `{ removed_words: [], count: 0 }` - **Changed Fields:** `[ \"words_removed(N)\" ]` ---
63544
- * @summary Remove words from language word list
63284
+ * Retrieves documents from a store with pagination and optional filtering
63285
+ * @summary Get documents from store
63545
63286
  * @param {string} xStoreID X-Store ID
63546
- * @param {number} wordListID Word List ID
63547
- * @param {DataTypesRemoveWordsFromLanguageListRequest} dataTypesRemoveWordsFromLanguageListRequest Remove words request
63287
+ * @param {number} [page] Page number (default: 1)
63288
+ * @param {number} [limit] Results per page (default: 20, max: 100)
63289
+ * @param {string} [search] Search query
63290
+ * @param {string} [filter] JSON filter object
63291
+ * @param {string} [sort] Sort field and direction (e.g., \&#39;created_at:desc\&#39;)
63548
63292
  * @param {*} [options] Override http request option.
63549
63293
  * @throws {RequiredError}
63550
- * @memberof StopwordsApi
63551
63294
  */
63552
- adminStoresXStoreIDStopwordsWordlistsWordListIDWordsDelete(xStoreID: string, wordListID: number, dataTypesRemoveWordsFromLanguageListRequest: DataTypesRemoveWordsFromLanguageListRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesUpdateWordStatusResponseWrapper, any, {}>>;
63295
+ adminStoresXStoreIDDocumentsGet: (xStoreID: string, page?: number, limit?: number, search?: string, filter?: string, sort?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63553
63296
  /**
63554
- * Adds one or more words to a language-based stopword list for a store. Also records Activity Logs capturing before/after state and changed fields.
63555
- * @summary Add words to language word list
63297
+ * Inserts a new document into a store. If ID is provided, it will be used; otherwise, a hash-based ID will be generated. If a document with the same hash already exists, it will be updated.
63298
+ * @summary Insert document
63556
63299
  * @param {string} xStoreID X-Store ID
63557
- * @param {number} wordListID Word List ID
63558
- * @param {DataTypesAddWordsToLanguageListRequest} dataTypesAddWordsToLanguageListRequest Add words request
63300
+ * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
63559
63301
  * @param {*} [options] Override http request option.
63560
63302
  * @throws {RequiredError}
63561
- * @memberof StopwordsApi
63562
63303
  */
63563
- adminStoresXStoreIDStopwordsWordlistsWordListIDWordsPost(xStoreID: string, wordListID: number, dataTypesAddWordsToLanguageListRequest: DataTypesAddWordsToLanguageListRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesUpdateWordStatusResponseWrapper, any, {}>>;
63564
- }
63304
+ adminStoresXStoreIDDocumentsPost: (xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63305
+ };
63565
63306
  /**
63566
- * StoreCreationApi - axios parameter creator
63307
+ * StoreDocumentsApi - functional programming interface
63567
63308
  * @export
63568
63309
  */
63569
- export declare const StoreCreationApiAxiosParamCreator: (configuration?: Configuration) => {
63310
+ export declare const StoreDocumentsApiFp: (configuration?: Configuration) => {
63570
63311
  /**
63571
- * Retrieves validation errors for a specific job ID if any invalid records were found during data upload
63572
- * @summary Get validation errors for a job
63573
- * @param {string} jobid Job ID
63312
+ *
63313
+ * @summary Bulk document operations
63314
+ * @param {string} xStoreID X-Store ID
63315
+ * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest Bulk operation data
63574
63316
  * @param {*} [options] Override http request option.
63575
63317
  * @throws {RequiredError}
63576
63318
  */
63577
- adminV1StoreCreationJobstatusJobidValidationErrorsGet: (jobid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63319
+ adminStoresXStoreIDDocumentsBulkPost(xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesBulkDocumentResponseWrapper>>;
63578
63320
  /**
63579
- * Deletes (soft delete) the current store creation progress
63580
- * @summary Delete store creation progress
63321
+ * Deletes a document by ID from a store
63322
+ * @summary Delete document
63323
+ * @param {string} xStoreID X-Store ID
63324
+ * @param {string} documentID Document ID
63581
63325
  * @param {*} [options] Override http request option.
63582
63326
  * @throws {RequiredError}
63583
63327
  */
63584
- adminV1StoreCreationProgressDelete: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63328
+ adminStoresXStoreIDDocumentsDocumentIDDelete(xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
63585
63329
  /**
63586
- * Retrieves the current step and state of store creation for the user. This endpoint gets the most recent store creation progress. For specific store creation flows, use the path-based endpoint with xstoreid.
63587
- * @summary Get current store creation progress
63330
+ * Retrieves a single document by ID from a store
63331
+ * @summary Get single document
63332
+ * @param {string} xStoreID X-Store ID
63333
+ * @param {string} documentID Document ID
63588
63334
  * @param {*} [options] Override http request option.
63589
63335
  * @throws {RequiredError}
63590
63336
  */
63591
- adminV1StoreCreationProgressGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63337
+ adminStoresXStoreIDDocumentsDocumentIDGet(xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
63592
63338
  /**
63593
- * Uploads a custom schema JSON file for store data structure definition
63594
- * @summary Upload custom schema for store
63595
- * @param {File} file Schema JSON file
63339
+ *
63340
+ * @summary Update document
63341
+ * @param {string} xStoreID X-Store ID
63342
+ * @param {string} documentID Document ID
63343
+ * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
63596
63344
  * @param {*} [options] Override http request option.
63597
63345
  * @throws {RequiredError}
63598
63346
  */
63599
- adminV1StoreCreationSchemaUploadPost: (file: File, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63347
+ adminStoresXStoreIDDocumentsDocumentIDPut(xStoreID: string, documentID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
63600
63348
  /**
63601
- * Updates a specific step in the store creation flow. This endpoint updates the most recent store creation progress. For specific store creation flows, use the path-based endpoint with xstoreid.
63602
- * @summary Update store creation step
63603
- * @param {DataTypesStoreCreationRequest} dataTypesStoreCreationRequest Store creation step data
63349
+ * Retrieves documents from a store with pagination and optional filtering
63350
+ * @summary Get documents from store
63351
+ * @param {string} xStoreID X-Store ID
63352
+ * @param {number} [page] Page number (default: 1)
63353
+ * @param {number} [limit] Results per page (default: 20, max: 100)
63354
+ * @param {string} [search] Search query
63355
+ * @param {string} [filter] JSON filter object
63356
+ * @param {string} [sort] Sort field and direction (e.g., \&#39;created_at:desc\&#39;)
63604
63357
  * @param {*} [options] Override http request option.
63605
63358
  * @throws {RequiredError}
63606
63359
  */
63607
- adminV1StoreCreationStepPost: (dataTypesStoreCreationRequest: DataTypesStoreCreationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63360
+ adminStoresXStoreIDDocumentsGet(xStoreID: string, page?: number, limit?: number, search?: string, filter?: string, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentListResponseWrapper>>;
63608
63361
  /**
63609
- * Retrieves validation status and results for a validation job. Poll this endpoint to check if validation is complete.
63610
- * @summary Get validation status and results
63611
- * @param {string} validationJobId Validation Job ID
63362
+ * Inserts a new document into a store. If ID is provided, it will be used; otherwise, a hash-based ID will be generated. If a document with the same hash already exists, it will be updated.
63363
+ * @summary Insert document
63364
+ * @param {string} xStoreID X-Store ID
63365
+ * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
63612
63366
  * @param {*} [options] Override http request option.
63613
63367
  * @throws {RequiredError}
63614
63368
  */
63615
- adminV1StoreCreationValidationStatusValidationJobIdGet: (validationJobId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63369
+ adminStoresXStoreIDDocumentsPost(xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
63370
+ };
63371
+ /**
63372
+ * StoreDocumentsApi - factory interface
63373
+ * @export
63374
+ */
63375
+ export declare const StoreDocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
63616
63376
  /**
63617
- * Proceeds with importing data after validation. Can import only valid records if proceedWithPartial is true.
63618
- * @summary Proceed with import after validation
63619
- * @param {string} xstoreid Store XStoreID
63620
- * @param {DataTypesProceedWithImportRequest} dataTypesProceedWithImportRequest Proceed import request
63377
+ *
63378
+ * @summary Bulk document operations
63379
+ * @param {string} xStoreID X-Store ID
63380
+ * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest Bulk operation data
63621
63381
  * @param {*} [options] Override http request option.
63622
63382
  * @throws {RequiredError}
63623
63383
  */
63624
- adminV1StoreCreationXstoreidProceedImportPost: (xstoreid: string, dataTypesProceedWithImportRequest: DataTypesProceedWithImportRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63384
+ adminStoresXStoreIDDocumentsBulkPost(xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesBulkDocumentResponseWrapper>;
63625
63385
  /**
63626
- * Deletes (soft delete) the store creation progress for a specific store using XStoreID from path parameter
63627
- * @summary Delete store creation progress by XStoreID
63628
- * @param {string} xstoreid XStoreID for specific store creation flow
63386
+ * Deletes a document by ID from a store
63387
+ * @summary Delete document
63388
+ * @param {string} xStoreID X-Store ID
63389
+ * @param {string} documentID Document ID
63629
63390
  * @param {*} [options] Override http request option.
63630
63391
  * @throws {RequiredError}
63631
63392
  */
63632
- adminV1StoreCreationXstoreidProgressDelete: (xstoreid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63393
+ adminStoresXStoreIDDocumentsDocumentIDDelete(xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
63633
63394
  /**
63634
- * Retrieves the current step and state of store creation for a specific store using XStoreID from path parameter
63635
- * @summary Get store creation progress by XStoreID
63636
- * @param {string} xstoreid XStoreID for specific store creation flow
63395
+ * Retrieves a single document by ID from a store
63396
+ * @summary Get single document
63397
+ * @param {string} xStoreID X-Store ID
63398
+ * @param {string} documentID Document ID
63637
63399
  * @param {*} [options] Override http request option.
63638
63400
  * @throws {RequiredError}
63639
63401
  */
63640
- adminV1StoreCreationXstoreidProgressGet: (xstoreid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63402
+ adminStoresXStoreIDDocumentsDocumentIDGet(xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
63641
63403
  /**
63642
- * Updates a specific step in the store creation flow for a specific store using XStoreID from path parameter
63643
- * @summary Update store creation step by XStoreID
63644
- * @param {string} xstoreid XStoreID for specific store creation flow
63645
- * @param {DataTypesStoreCreationRequest} dataTypesStoreCreationRequest Store creation step data
63404
+ *
63405
+ * @summary Update document
63406
+ * @param {string} xStoreID X-Store ID
63407
+ * @param {string} documentID Document ID
63408
+ * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
63646
63409
  * @param {*} [options] Override http request option.
63647
63410
  * @throws {RequiredError}
63648
63411
  */
63649
- adminV1StoreCreationXstoreidStepPost: (xstoreid: string, dataTypesStoreCreationRequest: DataTypesStoreCreationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63412
+ adminStoresXStoreIDDocumentsDocumentIDPut(xStoreID: string, documentID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
63650
63413
  /**
63651
- * Uploads a custom JSON or CSV file for store data import
63652
- * @summary Upload custom data file for store
63653
- * @param {string} xstoreid Store XStoreID
63654
- * @param {File} file Data file (JSON or CSV)
63414
+ * Retrieves documents from a store with pagination and optional filtering
63415
+ * @summary Get documents from store
63416
+ * @param {string} xStoreID X-Store ID
63417
+ * @param {number} [page] Page number (default: 1)
63418
+ * @param {number} [limit] Results per page (default: 20, max: 100)
63419
+ * @param {string} [search] Search query
63420
+ * @param {string} [filter] JSON filter object
63421
+ * @param {string} [sort] Sort field and direction (e.g., \&#39;created_at:desc\&#39;)
63655
63422
  * @param {*} [options] Override http request option.
63656
63423
  * @throws {RequiredError}
63657
63424
  */
63658
- adminV1StoreCreationXstoreidUploadDataPost: (xstoreid: string, file: File, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63425
+ adminStoresXStoreIDDocumentsGet(xStoreID: string, page?: number, limit?: number, search?: string, filter?: string, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentListResponseWrapper>;
63659
63426
  /**
63660
- * Validates uploaded data file and returns validation results without importing. Use this to check for errors before proceeding with import.
63661
- * @summary Validate uploaded data without importing
63662
- * @param {string} xstoreid Store XStoreID
63663
- * @param {File} file Data file (JSON or CSV)
63427
+ * Inserts a new document into a store. If ID is provided, it will be used; otherwise, a hash-based ID will be generated. If a document with the same hash already exists, it will be updated.
63428
+ * @summary Insert document
63429
+ * @param {string} xStoreID X-Store ID
63430
+ * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
63664
63431
  * @param {*} [options] Override http request option.
63665
63432
  * @throws {RequiredError}
63666
63433
  */
63667
- adminV1StoreCreationXstoreidValidateDataPost: (xstoreid: string, file: File, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63434
+ adminStoresXStoreIDDocumentsPost(xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
63668
63435
  };
63669
63436
  /**
63670
- * StoreCreationApi - functional programming interface
63437
+ * StoreDocumentsApi - object-oriented interface
63671
63438
  * @export
63439
+ * @class StoreDocumentsApi
63440
+ * @extends {BaseAPI}
63672
63441
  */
63673
- export declare const StoreCreationApiFp: (configuration?: Configuration) => {
63442
+ export declare class StoreDocumentsApi extends BaseAPI {
63674
63443
  /**
63675
- * Retrieves validation errors for a specific job ID if any invalid records were found during data upload
63676
- * @summary Get validation errors for a job
63677
- * @param {string} jobid Job ID
63444
+ *
63445
+ * @summary Bulk document operations
63446
+ * @param {string} xStoreID X-Store ID
63447
+ * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest Bulk operation data
63678
63448
  * @param {*} [options] Override http request option.
63679
63449
  * @throws {RequiredError}
63450
+ * @memberof StoreDocumentsApi
63680
63451
  */
63681
- adminV1StoreCreationJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesValidationErrorResponse>>;
63452
+ adminStoresXStoreIDDocumentsBulkPost(xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesBulkDocumentResponseWrapper, any, {}>>;
63682
63453
  /**
63683
- * Deletes (soft delete) the current store creation progress
63684
- * @summary Delete store creation progress
63454
+ * Deletes a document by ID from a store
63455
+ * @summary Delete document
63456
+ * @param {string} xStoreID X-Store ID
63457
+ * @param {string} documentID Document ID
63685
63458
  * @param {*} [options] Override http request option.
63686
63459
  * @throws {RequiredError}
63460
+ * @memberof StoreDocumentsApi
63687
63461
  */
63688
- adminV1StoreCreationProgressDelete(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
63462
+ adminStoresXStoreIDDocumentsDocumentIDDelete(xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
63689
63463
  /**
63690
- * Retrieves the current step and state of store creation for the user. This endpoint gets the most recent store creation progress. For specific store creation flows, use the path-based endpoint with xstoreid.
63691
- * @summary Get current store creation progress
63464
+ * Retrieves a single document by ID from a store
63465
+ * @summary Get single document
63466
+ * @param {string} xStoreID X-Store ID
63467
+ * @param {string} documentID Document ID
63692
63468
  * @param {*} [options] Override http request option.
63693
63469
  * @throws {RequiredError}
63470
+ * @memberof StoreDocumentsApi
63694
63471
  */
63695
- adminV1StoreCreationProgressGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesStoreCreationResponseWrapper>>;
63472
+ adminStoresXStoreIDDocumentsDocumentIDGet(xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
63696
63473
  /**
63697
- * Uploads a custom schema JSON file for store data structure definition
63698
- * @summary Upload custom schema for store
63699
- * @param {File} file Schema JSON file
63474
+ *
63475
+ * @summary Update document
63476
+ * @param {string} xStoreID X-Store ID
63477
+ * @param {string} documentID Document ID
63478
+ * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
63700
63479
  * @param {*} [options] Override http request option.
63701
63480
  * @throws {RequiredError}
63481
+ * @memberof StoreDocumentsApi
63702
63482
  */
63703
- adminV1StoreCreationSchemaUploadPost(file: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
63483
+ adminStoresXStoreIDDocumentsDocumentIDPut(xStoreID: string, documentID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
63704
63484
  /**
63705
- * Updates a specific step in the store creation flow. This endpoint updates the most recent store creation progress. For specific store creation flows, use the path-based endpoint with xstoreid.
63706
- * @summary Update store creation step
63707
- * @param {DataTypesStoreCreationRequest} dataTypesStoreCreationRequest Store creation step data
63485
+ * Retrieves documents from a store with pagination and optional filtering
63486
+ * @summary Get documents from store
63487
+ * @param {string} xStoreID X-Store ID
63488
+ * @param {number} [page] Page number (default: 1)
63489
+ * @param {number} [limit] Results per page (default: 20, max: 100)
63490
+ * @param {string} [search] Search query
63491
+ * @param {string} [filter] JSON filter object
63492
+ * @param {string} [sort] Sort field and direction (e.g., \&#39;created_at:desc\&#39;)
63708
63493
  * @param {*} [options] Override http request option.
63709
63494
  * @throws {RequiredError}
63495
+ * @memberof StoreDocumentsApi
63710
63496
  */
63711
- adminV1StoreCreationStepPost(dataTypesStoreCreationRequest: DataTypesStoreCreationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesStoreCreationResponseWrapper>>;
63497
+ adminStoresXStoreIDDocumentsGet(xStoreID: string, page?: number, limit?: number, search?: string, filter?: string, sort?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentListResponseWrapper, any, {}>>;
63712
63498
  /**
63713
- * Retrieves validation status and results for a validation job. Poll this endpoint to check if validation is complete.
63714
- * @summary Get validation status and results
63715
- * @param {string} validationJobId Validation Job ID
63499
+ * Inserts a new document into a store. If ID is provided, it will be used; otherwise, a hash-based ID will be generated. If a document with the same hash already exists, it will be updated.
63500
+ * @summary Insert document
63501
+ * @param {string} xStoreID X-Store ID
63502
+ * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
63716
63503
  * @param {*} [options] Override http request option.
63717
63504
  * @throws {RequiredError}
63505
+ * @memberof StoreDocumentsApi
63718
63506
  */
63719
- adminV1StoreCreationValidationStatusValidationJobIdGet(validationJobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesValidationResultResponse>>;
63507
+ adminStoresXStoreIDDocumentsPost(xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
63508
+ }
63509
+ /**
63510
+ * StoreManagementApi - axios parameter creator
63511
+ * @export
63512
+ */
63513
+ export declare const StoreManagementApiAxiosParamCreator: (configuration?: Configuration) => {
63720
63514
  /**
63721
- * Proceeds with importing data after validation. Can import only valid records if proceedWithPartial is true.
63722
- * @summary Proceed with import after validation
63723
- * @param {string} xstoreid Store XStoreID
63724
- * @param {DataTypesProceedWithImportRequest} dataTypesProceedWithImportRequest Proceed import request
63515
+ * Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
63516
+ * @summary Create Store (Public SDK API)
63517
+ * @param {string} authorization Bearer JWT Token
63518
+ * @param {DataTypesPublicCreateStoreRequest} dataTypesPublicCreateStoreRequest Store creation request
63725
63519
  * @param {*} [options] Override http request option.
63726
63520
  * @throws {RequiredError}
63727
63521
  */
63728
- adminV1StoreCreationXstoreidProceedImportPost(xstoreid: string, dataTypesProceedWithImportRequest: DataTypesProceedWithImportRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
63522
+ apiV1StoresPost: (authorization: string, dataTypesPublicCreateStoreRequest: DataTypesPublicCreateStoreRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63729
63523
  /**
63730
- * Deletes (soft delete) the store creation progress for a specific store using XStoreID from path parameter
63731
- * @summary Delete store creation progress by XStoreID
63732
- * @param {string} xstoreid XStoreID for specific store creation flow
63524
+ * Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63525
+ * @summary Get store configuration
63526
+ * @param {string} xStoreid Store ID (from dashboard)
63527
+ * @param {string} xStoresecret Store read secret
63528
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63733
63529
  * @param {*} [options] Override http request option.
63734
63530
  * @throws {RequiredError}
63735
63531
  */
63736
- adminV1StoreCreationXstoreidProgressDelete(xstoreid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
63532
+ apiV1StoresXStoreIDConfigGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63737
63533
  /**
63738
- * Retrieves the current step and state of store creation for a specific store using XStoreID from path parameter
63739
- * @summary Get store creation progress by XStoreID
63740
- * @param {string} xstoreid XStoreID for specific store creation flow
63534
+ * Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
63535
+ * @summary Update store configuration
63536
+ * @param {string} xStoreid Store ID (from dashboard)
63537
+ * @param {string} xStoreWriteSecret Store write secret
63538
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63539
+ * @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
63741
63540
  * @param {*} [options] Override http request option.
63742
63541
  * @throws {RequiredError}
63743
63542
  */
63744
- adminV1StoreCreationXstoreidProgressGet(xstoreid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesStoreCreationResponseWrapper>>;
63543
+ apiV1StoresXStoreIDConfigPut: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63745
63544
  /**
63746
- * Updates a specific step in the store creation flow for a specific store using XStoreID from path parameter
63747
- * @summary Update store creation step by XStoreID
63748
- * @param {string} xstoreid XStoreID for specific store creation flow
63749
- * @param {DataTypesStoreCreationRequest} dataTypesStoreCreationRequest Store creation step data
63545
+ * Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63546
+ * @summary Get store config schema
63547
+ * @param {string} xStoreid Store ID (from dashboard)
63548
+ * @param {string} xStoresecret Store read secret
63549
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63750
63550
  * @param {*} [options] Override http request option.
63751
63551
  * @throws {RequiredError}
63752
63552
  */
63753
- adminV1StoreCreationXstoreidStepPost(xstoreid: string, dataTypesStoreCreationRequest: DataTypesStoreCreationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesStoreCreationResponseWrapper>>;
63553
+ apiV1StoresXStoreIDConfigSchemaGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63754
63554
  /**
63755
- * Uploads a custom JSON or CSV file for store data import
63756
- * @summary Upload custom data file for store
63757
- * @param {string} xstoreid Store XStoreID
63758
- * @param {File} file Data file (JSON or CSV)
63555
+ * Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. Each item can specify its own action.
63556
+ * @summary Bulk index documents
63557
+ * @param {string} xStoreid Store ID (from dashboard)
63558
+ * @param {string} xStoreWriteSecret Store write secret
63559
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63560
+ * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
63759
63561
  * @param {*} [options] Override http request option.
63760
63562
  * @throws {RequiredError}
63761
63563
  */
63762
- adminV1StoreCreationXstoreidUploadDataPost(xstoreid: string, file: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
63564
+ apiV1StoresXStoreIDDocumentsBulkPost: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63763
63565
  /**
63764
- * Validates uploaded data file and returns validation results without importing. Use this to check for errors before proceeding with import.
63765
- * @summary Validate uploaded data without importing
63766
- * @param {string} xstoreid Store XStoreID
63767
- * @param {File} file Data file (JSON or CSV)
63566
+ * Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
63567
+ * @summary Clear all documents
63568
+ * @param {string} xStoreid Store ID (from dashboard)
63569
+ * @param {string} xStoreWriteSecret Store write secret
63570
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63768
63571
  * @param {*} [options] Override http request option.
63769
63572
  * @throws {RequiredError}
63770
63573
  */
63771
- adminV1StoreCreationXstoreidValidateDataPost(xstoreid: string, file: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
63772
- };
63773
- /**
63774
- * StoreCreationApi - factory interface
63775
- * @export
63776
- */
63777
- export declare const StoreCreationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
63574
+ apiV1StoresXStoreIDDocumentsDelete: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63778
63575
  /**
63779
- * Retrieves validation errors for a specific job ID if any invalid records were found during data upload
63780
- * @summary Get validation errors for a job
63781
- * @param {string} jobid Job ID
63576
+ * Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
63577
+ * @summary Delete a document
63578
+ * @param {string} xStoreid Store ID (from dashboard)
63579
+ * @param {string} xStoreWriteSecret Store write secret
63580
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63581
+ * @param {string} documentID Document ID to delete
63782
63582
  * @param {*} [options] Override http request option.
63783
63583
  * @throws {RequiredError}
63784
63584
  */
63785
- adminV1StoreCreationJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesValidationErrorResponse>;
63585
+ apiV1StoresXStoreIDDocumentsDocumentIDDelete: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63786
63586
  /**
63787
- * Deletes (soft delete) the current store creation progress
63788
- * @summary Delete store creation progress
63587
+ * Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret` (read secret). Path `xStoreID` must match the `x-storeid` header. Used by product pages and PDP.
63588
+ * @summary Get a document by ID
63589
+ * @param {string} xStoreid Store ID (from dashboard)
63590
+ * @param {string} xStoresecret Store read secret
63591
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63592
+ * @param {string} documentID Document ID to retrieve
63789
63593
  * @param {*} [options] Override http request option.
63790
63594
  * @throws {RequiredError}
63791
63595
  */
63792
- adminV1StoreCreationProgressDelete(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
63596
+ apiV1StoresXStoreIDDocumentsDocumentIDGet: (xStoreid: string, xStoresecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63793
63597
  /**
63794
- * Retrieves the current step and state of store creation for the user. This endpoint gets the most recent store creation progress. For specific store creation flows, use the path-based endpoint with xstoreid.
63795
- * @summary Get current store creation progress
63598
+ * Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
63599
+ * @summary Index a single document
63600
+ * @param {string} xStoreid Store ID (from dashboard)
63601
+ * @param {string} xStoreWriteSecret Store write secret
63602
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63603
+ * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
63796
63604
  * @param {*} [options] Override http request option.
63797
63605
  * @throws {RequiredError}
63798
63606
  */
63799
- adminV1StoreCreationProgressGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesStoreCreationResponseWrapper>;
63607
+ apiV1StoresXStoreIDDocumentsPost: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63800
63608
  /**
63801
- * Uploads a custom schema JSON file for store data structure definition
63802
- * @summary Upload custom schema for store
63803
- * @param {File} file Schema JSON file
63609
+ * Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63610
+ * @summary Get store info
63611
+ * @param {string} xStoreid Store ID (from dashboard)
63612
+ * @param {string} xStoresecret Store read secret
63613
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63804
63614
  * @param {*} [options] Override http request option.
63805
63615
  * @throws {RequiredError}
63806
63616
  */
63807
- adminV1StoreCreationSchemaUploadPost(file: File, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
63617
+ apiV1StoresXStoreIDGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63808
63618
  /**
63809
- * Updates a specific step in the store creation flow. This endpoint updates the most recent store creation progress. For specific store creation flows, use the path-based endpoint with xstoreid.
63810
- * @summary Update store creation step
63811
- * @param {DataTypesStoreCreationRequest} dataTypesStoreCreationRequest Store creation step data
63619
+ * Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63620
+ * @summary Get query suggestions configuration
63621
+ * @param {string} xStoreid Store ID (from dashboard)
63622
+ * @param {string} xStoresecret Store read secret
63623
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63812
63624
  * @param {*} [options] Override http request option.
63813
63625
  * @throws {RequiredError}
63814
63626
  */
63815
- adminV1StoreCreationStepPost(dataTypesStoreCreationRequest: DataTypesStoreCreationRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesStoreCreationResponseWrapper>;
63627
+ apiV1StoresXStoreIDQuerySuggestionsConfigGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63816
63628
  /**
63817
- * Retrieves validation status and results for a validation job. Poll this endpoint to check if validation is complete.
63818
- * @summary Get validation status and results
63819
- * @param {string} validationJobId Validation Job ID
63629
+ * Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
63630
+ * @summary Update query suggestions configuration
63631
+ * @param {string} xStoreid Store ID (from dashboard)
63632
+ * @param {string} xStoreWriteSecret Store write secret
63633
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63634
+ * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
63820
63635
  * @param {*} [options] Override http request option.
63821
63636
  * @throws {RequiredError}
63822
63637
  */
63823
- adminV1StoreCreationValidationStatusValidationJobIdGet(validationJobId: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesValidationResultResponse>;
63638
+ apiV1StoresXStoreIDQuerySuggestionsConfigPut: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63824
63639
  /**
63825
- * Proceeds with importing data after validation. Can import only valid records if proceedWithPartial is true.
63826
- * @summary Proceed with import after validation
63827
- * @param {string} xstoreid Store XStoreID
63828
- * @param {DataTypesProceedWithImportRequest} dataTypesProceedWithImportRequest Proceed import request
63640
+ * Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63641
+ * @summary Get index schema
63642
+ * @param {string} xStoreid Store ID (from dashboard)
63643
+ * @param {string} xStoresecret Store read secret
63644
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63829
63645
  * @param {*} [options] Override http request option.
63830
63646
  * @throws {RequiredError}
63831
63647
  */
63832
- adminV1StoreCreationXstoreidProceedImportPost(xstoreid: string, dataTypesProceedWithImportRequest: DataTypesProceedWithImportRequest, options?: RawAxiosRequestConfig): AxiosPromise<object>;
63648
+ apiV1StoresXStoreIDSchemaGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63833
63649
  /**
63834
- * Deletes (soft delete) the store creation progress for a specific store using XStoreID from path parameter
63835
- * @summary Delete store creation progress by XStoreID
63836
- * @param {string} xstoreid XStoreID for specific store creation flow
63650
+ * Define or update the search index schema (field names, types, searchable/facet options). Mode: `additive` (add fields, keep data) or `replace` (recreate index). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
63651
+ * @summary Create or update index schema
63652
+ * @param {string} xStoreid Store ID (from dashboard)
63653
+ * @param {string} xStoreWriteSecret Store write secret
63654
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63655
+ * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
63837
63656
  * @param {*} [options] Override http request option.
63838
63657
  * @throws {RequiredError}
63839
63658
  */
63840
- adminV1StoreCreationXstoreidProgressDelete(xstoreid: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
63659
+ apiV1StoresXStoreIDSchemaPost: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63660
+ };
63661
+ /**
63662
+ * StoreManagementApi - functional programming interface
63663
+ * @export
63664
+ */
63665
+ export declare const StoreManagementApiFp: (configuration?: Configuration) => {
63841
63666
  /**
63842
- * Retrieves the current step and state of store creation for a specific store using XStoreID from path parameter
63843
- * @summary Get store creation progress by XStoreID
63844
- * @param {string} xstoreid XStoreID for specific store creation flow
63667
+ * Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
63668
+ * @summary Create Store (Public SDK API)
63669
+ * @param {string} authorization Bearer JWT Token
63670
+ * @param {DataTypesPublicCreateStoreRequest} dataTypesPublicCreateStoreRequest Store creation request
63845
63671
  * @param {*} [options] Override http request option.
63846
63672
  * @throws {RequiredError}
63847
63673
  */
63848
- adminV1StoreCreationXstoreidProgressGet(xstoreid: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesStoreCreationResponseWrapper>;
63674
+ apiV1StoresPost(authorization: string, dataTypesPublicCreateStoreRequest: DataTypesPublicCreateStoreRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesPublicCreateStoreResponse>>;
63849
63675
  /**
63850
- * Updates a specific step in the store creation flow for a specific store using XStoreID from path parameter
63851
- * @summary Update store creation step by XStoreID
63852
- * @param {string} xstoreid XStoreID for specific store creation flow
63853
- * @param {DataTypesStoreCreationRequest} dataTypesStoreCreationRequest Store creation step data
63676
+ * Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63677
+ * @summary Get store configuration
63678
+ * @param {string} xStoreid Store ID (from dashboard)
63679
+ * @param {string} xStoresecret Store read secret
63680
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63854
63681
  * @param {*} [options] Override http request option.
63855
63682
  * @throws {RequiredError}
63856
63683
  */
63857
- adminV1StoreCreationXstoreidStepPost(xstoreid: string, dataTypesStoreCreationRequest: DataTypesStoreCreationRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesStoreCreationResponseWrapper>;
63684
+ apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse>>;
63858
63685
  /**
63859
- * Uploads a custom JSON or CSV file for store data import
63860
- * @summary Upload custom data file for store
63861
- * @param {string} xstoreid Store XStoreID
63862
- * @param {File} file Data file (JSON or CSV)
63686
+ * Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
63687
+ * @summary Update store configuration
63688
+ * @param {string} xStoreid Store ID (from dashboard)
63689
+ * @param {string} xStoreWriteSecret Store write secret
63690
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63691
+ * @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
63863
63692
  * @param {*} [options] Override http request option.
63864
63693
  * @throws {RequiredError}
63865
63694
  */
63866
- adminV1StoreCreationXstoreidUploadDataPost(xstoreid: string, file: File, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
63695
+ apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponseWrapper>>;
63867
63696
  /**
63868
- * Validates uploaded data file and returns validation results without importing. Use this to check for errors before proceeding with import.
63869
- * @summary Validate uploaded data without importing
63870
- * @param {string} xstoreid Store XStoreID
63871
- * @param {File} file Data file (JSON or CSV)
63697
+ * Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63698
+ * @summary Get store config schema
63699
+ * @param {string} xStoreid Store ID (from dashboard)
63700
+ * @param {string} xStoresecret Store read secret
63701
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63872
63702
  * @param {*} [options] Override http request option.
63873
63703
  * @throws {RequiredError}
63874
63704
  */
63875
- adminV1StoreCreationXstoreidValidateDataPost(xstoreid: string, file: File, options?: RawAxiosRequestConfig): AxiosPromise<object>;
63876
- };
63877
- /**
63878
- * StoreCreationApi - object-oriented interface
63879
- * @export
63880
- * @class StoreCreationApi
63881
- * @extends {BaseAPI}
63882
- */
63883
- export declare class StoreCreationApi extends BaseAPI {
63705
+ apiV1StoresXStoreIDConfigSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>>;
63884
63706
  /**
63885
- * Retrieves validation errors for a specific job ID if any invalid records were found during data upload
63886
- * @summary Get validation errors for a job
63887
- * @param {string} jobid Job ID
63707
+ * Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. Each item can specify its own action.
63708
+ * @summary Bulk index documents
63709
+ * @param {string} xStoreid Store ID (from dashboard)
63710
+ * @param {string} xStoreWriteSecret Store write secret
63711
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63712
+ * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
63888
63713
  * @param {*} [options] Override http request option.
63889
63714
  * @throws {RequiredError}
63890
- * @memberof StoreCreationApi
63891
63715
  */
63892
- adminV1StoreCreationJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesValidationErrorResponse, any, {}>>;
63716
+ apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesBulkDocumentResponseWrapper>>;
63893
63717
  /**
63894
- * Deletes (soft delete) the current store creation progress
63895
- * @summary Delete store creation progress
63718
+ * Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
63719
+ * @summary Clear all documents
63720
+ * @param {string} xStoreid Store ID (from dashboard)
63721
+ * @param {string} xStoreWriteSecret Store write secret
63722
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63896
63723
  * @param {*} [options] Override http request option.
63897
63724
  * @throws {RequiredError}
63898
- * @memberof StoreCreationApi
63899
63725
  */
63900
- adminV1StoreCreationProgressDelete(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
63726
+ apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesClearDocumentsResponseWrapper>>;
63901
63727
  /**
63902
- * Retrieves the current step and state of store creation for the user. This endpoint gets the most recent store creation progress. For specific store creation flows, use the path-based endpoint with xstoreid.
63903
- * @summary Get current store creation progress
63728
+ * Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
63729
+ * @summary Delete a document
63730
+ * @param {string} xStoreid Store ID (from dashboard)
63731
+ * @param {string} xStoreWriteSecret Store write secret
63732
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63733
+ * @param {string} documentID Document ID to delete
63904
63734
  * @param {*} [options] Override http request option.
63905
63735
  * @throws {RequiredError}
63906
- * @memberof StoreCreationApi
63907
63736
  */
63908
- adminV1StoreCreationProgressGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesStoreCreationResponseWrapper, any, {}>>;
63737
+ apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
63909
63738
  /**
63910
- * Uploads a custom schema JSON file for store data structure definition
63911
- * @summary Upload custom schema for store
63912
- * @param {File} file Schema JSON file
63739
+ * Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret` (read secret). Path `xStoreID` must match the `x-storeid` header. Used by product pages and PDP.
63740
+ * @summary Get a document by ID
63741
+ * @param {string} xStoreid Store ID (from dashboard)
63742
+ * @param {string} xStoresecret Store read secret
63743
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63744
+ * @param {string} documentID Document ID to retrieve
63913
63745
  * @param {*} [options] Override http request option.
63914
63746
  * @throws {RequiredError}
63915
- * @memberof StoreCreationApi
63916
63747
  */
63917
- adminV1StoreCreationSchemaUploadPost(file: File, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
63748
+ apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
63918
63749
  /**
63919
- * Updates a specific step in the store creation flow. This endpoint updates the most recent store creation progress. For specific store creation flows, use the path-based endpoint with xstoreid.
63920
- * @summary Update store creation step
63921
- * @param {DataTypesStoreCreationRequest} dataTypesStoreCreationRequest Store creation step data
63750
+ * Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
63751
+ * @summary Index a single document
63752
+ * @param {string} xStoreid Store ID (from dashboard)
63753
+ * @param {string} xStoreWriteSecret Store write secret
63754
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63755
+ * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
63922
63756
  * @param {*} [options] Override http request option.
63923
63757
  * @throws {RequiredError}
63924
- * @memberof StoreCreationApi
63925
63758
  */
63926
- adminV1StoreCreationStepPost(dataTypesStoreCreationRequest: DataTypesStoreCreationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesStoreCreationResponseWrapper, any, {}>>;
63759
+ apiV1StoresXStoreIDDocumentsPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
63927
63760
  /**
63928
- * Retrieves validation status and results for a validation job. Poll this endpoint to check if validation is complete.
63929
- * @summary Get validation status and results
63930
- * @param {string} validationJobId Validation Job ID
63761
+ * Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63762
+ * @summary Get store info
63763
+ * @param {string} xStoreid Store ID (from dashboard)
63764
+ * @param {string} xStoresecret Store read secret
63765
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63931
63766
  * @param {*} [options] Override http request option.
63932
63767
  * @throws {RequiredError}
63933
- * @memberof StoreCreationApi
63934
63768
  */
63935
- adminV1StoreCreationValidationStatusValidationJobIdGet(validationJobId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesValidationResultResponse, any, {}>>;
63769
+ apiV1StoresXStoreIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesPublicStoreInfoResponse>>;
63936
63770
  /**
63937
- * Proceeds with importing data after validation. Can import only valid records if proceedWithPartial is true.
63938
- * @summary Proceed with import after validation
63939
- * @param {string} xstoreid Store XStoreID
63940
- * @param {DataTypesProceedWithImportRequest} dataTypesProceedWithImportRequest Proceed import request
63771
+ * Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63772
+ * @summary Get query suggestions configuration
63773
+ * @param {string} xStoreid Store ID (from dashboard)
63774
+ * @param {string} xStoresecret Store read secret
63775
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63941
63776
  * @param {*} [options] Override http request option.
63942
63777
  * @throws {RequiredError}
63943
- * @memberof StoreCreationApi
63944
63778
  */
63945
- adminV1StoreCreationXstoreidProceedImportPost(xstoreid: string, dataTypesProceedWithImportRequest: DataTypesProceedWithImportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
63779
+ apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>>;
63946
63780
  /**
63947
- * Deletes (soft delete) the store creation progress for a specific store using XStoreID from path parameter
63948
- * @summary Delete store creation progress by XStoreID
63949
- * @param {string} xstoreid XStoreID for specific store creation flow
63781
+ * Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
63782
+ * @summary Update query suggestions configuration
63783
+ * @param {string} xStoreid Store ID (from dashboard)
63784
+ * @param {string} xStoreWriteSecret Store write secret
63785
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63786
+ * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
63950
63787
  * @param {*} [options] Override http request option.
63951
63788
  * @throws {RequiredError}
63952
- * @memberof StoreCreationApi
63953
63789
  */
63954
- adminV1StoreCreationXstoreidProgressDelete(xstoreid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
63790
+ apiV1StoresXStoreIDQuerySuggestionsConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>>;
63955
63791
  /**
63956
- * Retrieves the current step and state of store creation for a specific store using XStoreID from path parameter
63957
- * @summary Get store creation progress by XStoreID
63958
- * @param {string} xstoreid XStoreID for specific store creation flow
63792
+ * Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63793
+ * @summary Get index schema
63794
+ * @param {string} xStoreid Store ID (from dashboard)
63795
+ * @param {string} xStoresecret Store read secret
63796
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63959
63797
  * @param {*} [options] Override http request option.
63960
63798
  * @throws {RequiredError}
63961
- * @memberof StoreCreationApi
63962
63799
  */
63963
- adminV1StoreCreationXstoreidProgressGet(xstoreid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesStoreCreationResponseWrapper, any, {}>>;
63800
+ apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaResponseWrapper>>;
63964
63801
  /**
63965
- * Updates a specific step in the store creation flow for a specific store using XStoreID from path parameter
63966
- * @summary Update store creation step by XStoreID
63967
- * @param {string} xstoreid XStoreID for specific store creation flow
63968
- * @param {DataTypesStoreCreationRequest} dataTypesStoreCreationRequest Store creation step data
63802
+ * Define or update the search index schema (field names, types, searchable/facet options). Mode: `additive` (add fields, keep data) or `replace` (recreate index). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
63803
+ * @summary Create or update index schema
63804
+ * @param {string} xStoreid Store ID (from dashboard)
63805
+ * @param {string} xStoreWriteSecret Store write secret
63806
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63807
+ * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
63969
63808
  * @param {*} [options] Override http request option.
63970
63809
  * @throws {RequiredError}
63971
- * @memberof StoreCreationApi
63972
63810
  */
63973
- adminV1StoreCreationXstoreidStepPost(xstoreid: string, dataTypesStoreCreationRequest: DataTypesStoreCreationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesStoreCreationResponseWrapper, any, {}>>;
63811
+ apiV1StoresXStoreIDSchemaPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaResponseWrapper>>;
63812
+ };
63813
+ /**
63814
+ * StoreManagementApi - factory interface
63815
+ * @export
63816
+ */
63817
+ export declare const StoreManagementApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
63974
63818
  /**
63975
- * Uploads a custom JSON or CSV file for store data import
63976
- * @summary Upload custom data file for store
63977
- * @param {string} xstoreid Store XStoreID
63978
- * @param {File} file Data file (JSON or CSV)
63819
+ * Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
63820
+ * @summary Create Store (Public SDK API)
63821
+ * @param {string} authorization Bearer JWT Token
63822
+ * @param {DataTypesPublicCreateStoreRequest} dataTypesPublicCreateStoreRequest Store creation request
63979
63823
  * @param {*} [options] Override http request option.
63980
63824
  * @throws {RequiredError}
63981
- * @memberof StoreCreationApi
63982
63825
  */
63983
- adminV1StoreCreationXstoreidUploadDataPost(xstoreid: string, file: File, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
63826
+ apiV1StoresPost(authorization: string, dataTypesPublicCreateStoreRequest: DataTypesPublicCreateStoreRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesPublicCreateStoreResponse>;
63984
63827
  /**
63985
- * Validates uploaded data file and returns validation results without importing. Use this to check for errors before proceeding with import.
63986
- * @summary Validate uploaded data without importing
63987
- * @param {string} xstoreid Store XStoreID
63988
- * @param {File} file Data file (JSON or CSV)
63828
+ * Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63829
+ * @summary Get store configuration
63830
+ * @param {string} xStoreid Store ID (from dashboard)
63831
+ * @param {string} xStoresecret Store read secret
63832
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63989
63833
  * @param {*} [options] Override http request option.
63990
63834
  * @throws {RequiredError}
63991
- * @memberof StoreCreationApi
63992
63835
  */
63993
- adminV1StoreCreationXstoreidValidateDataPost(xstoreid: string, file: File, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
63994
- }
63995
- /**
63996
- * StoreDocumentsApi - axios parameter creator
63997
- * @export
63998
- */
63999
- export declare const StoreDocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
63836
+ apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse>;
64000
63837
  /**
64001
- *
64002
- * @summary Bulk document operations
64003
- * @param {string} xStoreID X-Store ID
64004
- * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest Bulk operation data
63838
+ * Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
63839
+ * @summary Update store configuration
63840
+ * @param {string} xStoreid Store ID (from dashboard)
63841
+ * @param {string} xStoreWriteSecret Store write secret
63842
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63843
+ * @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
64005
63844
  * @param {*} [options] Override http request option.
64006
63845
  * @throws {RequiredError}
64007
63846
  */
64008
- adminStoresXStoreIDDocumentsBulkPost: (xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63847
+ apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponseWrapper>;
64009
63848
  /**
64010
- * Deletes a document by ID from a store
64011
- * @summary Delete document
64012
- * @param {string} xStoreID X-Store ID
64013
- * @param {string} documentID Document ID
63849
+ * Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63850
+ * @summary Get store config schema
63851
+ * @param {string} xStoreid Store ID (from dashboard)
63852
+ * @param {string} xStoresecret Store read secret
63853
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64014
63854
  * @param {*} [options] Override http request option.
64015
63855
  * @throws {RequiredError}
64016
63856
  */
64017
- adminStoresXStoreIDDocumentsDocumentIDDelete: (xStoreID: string, documentID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63857
+ apiV1StoresXStoreIDConfigSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>;
64018
63858
  /**
64019
- * Retrieves a single document by ID from a store
64020
- * @summary Get single document
64021
- * @param {string} xStoreID X-Store ID
64022
- * @param {string} documentID Document ID
63859
+ * Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. Each item can specify its own action.
63860
+ * @summary Bulk index documents
63861
+ * @param {string} xStoreid Store ID (from dashboard)
63862
+ * @param {string} xStoreWriteSecret Store write secret
63863
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63864
+ * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
64023
63865
  * @param {*} [options] Override http request option.
64024
63866
  * @throws {RequiredError}
64025
63867
  */
64026
- adminStoresXStoreIDDocumentsDocumentIDGet: (xStoreID: string, documentID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63868
+ apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesBulkDocumentResponseWrapper>;
64027
63869
  /**
64028
- *
64029
- * @summary Update document
64030
- * @param {string} xStoreID X-Store ID
64031
- * @param {string} documentID Document ID
64032
- * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
63870
+ * Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
63871
+ * @summary Clear all documents
63872
+ * @param {string} xStoreid Store ID (from dashboard)
63873
+ * @param {string} xStoreWriteSecret Store write secret
63874
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64033
63875
  * @param {*} [options] Override http request option.
64034
63876
  * @throws {RequiredError}
64035
63877
  */
64036
- adminStoresXStoreIDDocumentsDocumentIDPut: (xStoreID: string, documentID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63878
+ apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesClearDocumentsResponseWrapper>;
64037
63879
  /**
64038
- * Retrieves documents from a store with pagination and optional filtering
64039
- * @summary Get documents from store
64040
- * @param {string} xStoreID X-Store ID
64041
- * @param {number} [page] Page number (default: 1)
64042
- * @param {number} [limit] Results per page (default: 20, max: 100)
64043
- * @param {string} [search] Search query
64044
- * @param {string} [filter] JSON filter object
64045
- * @param {string} [sort] Sort field and direction (e.g., \&#39;created_at:desc\&#39;)
63880
+ * Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
63881
+ * @summary Delete a document
63882
+ * @param {string} xStoreid Store ID (from dashboard)
63883
+ * @param {string} xStoreWriteSecret Store write secret
63884
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63885
+ * @param {string} documentID Document ID to delete
64046
63886
  * @param {*} [options] Override http request option.
64047
63887
  * @throws {RequiredError}
64048
63888
  */
64049
- adminStoresXStoreIDDocumentsGet: (xStoreID: string, page?: number, limit?: number, search?: string, filter?: string, sort?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63889
+ apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
64050
63890
  /**
64051
- * Inserts a new document into a store. If ID is provided, it will be used; otherwise, a hash-based ID will be generated. If a document with the same hash already exists, it will be updated.
64052
- * @summary Insert document
64053
- * @param {string} xStoreID X-Store ID
64054
- * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
63891
+ * Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret` (read secret). Path `xStoreID` must match the `x-storeid` header. Used by product pages and PDP.
63892
+ * @summary Get a document by ID
63893
+ * @param {string} xStoreid Store ID (from dashboard)
63894
+ * @param {string} xStoresecret Store read secret
63895
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63896
+ * @param {string} documentID Document ID to retrieve
64055
63897
  * @param {*} [options] Override http request option.
64056
63898
  * @throws {RequiredError}
64057
63899
  */
64058
- adminStoresXStoreIDDocumentsPost: (xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
64059
- };
64060
- /**
64061
- * StoreDocumentsApi - functional programming interface
64062
- * @export
64063
- */
64064
- export declare const StoreDocumentsApiFp: (configuration?: Configuration) => {
64065
- /**
64066
- *
64067
- * @summary Bulk document operations
64068
- * @param {string} xStoreID X-Store ID
64069
- * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest Bulk operation data
63900
+ apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
63901
+ /**
63902
+ * Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
63903
+ * @summary Index a single document
63904
+ * @param {string} xStoreid Store ID (from dashboard)
63905
+ * @param {string} xStoreWriteSecret Store write secret
63906
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63907
+ * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
64070
63908
  * @param {*} [options] Override http request option.
64071
63909
  * @throws {RequiredError}
64072
63910
  */
64073
- adminStoresXStoreIDDocumentsBulkPost(xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesBulkDocumentResponseWrapper>>;
63911
+ apiV1StoresXStoreIDDocumentsPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
64074
63912
  /**
64075
- * Deletes a document by ID from a store
64076
- * @summary Delete document
64077
- * @param {string} xStoreID X-Store ID
64078
- * @param {string} documentID Document ID
63913
+ * Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63914
+ * @summary Get store info
63915
+ * @param {string} xStoreid Store ID (from dashboard)
63916
+ * @param {string} xStoresecret Store read secret
63917
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64079
63918
  * @param {*} [options] Override http request option.
64080
63919
  * @throws {RequiredError}
64081
63920
  */
64082
- adminStoresXStoreIDDocumentsDocumentIDDelete(xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
63921
+ apiV1StoresXStoreIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesPublicStoreInfoResponse>;
64083
63922
  /**
64084
- * Retrieves a single document by ID from a store
64085
- * @summary Get single document
64086
- * @param {string} xStoreID X-Store ID
64087
- * @param {string} documentID Document ID
63923
+ * Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63924
+ * @summary Get query suggestions configuration
63925
+ * @param {string} xStoreid Store ID (from dashboard)
63926
+ * @param {string} xStoresecret Store read secret
63927
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64088
63928
  * @param {*} [options] Override http request option.
64089
63929
  * @throws {RequiredError}
64090
63930
  */
64091
- adminStoresXStoreIDDocumentsDocumentIDGet(xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
63931
+ apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>;
64092
63932
  /**
64093
- *
64094
- * @summary Update document
64095
- * @param {string} xStoreID X-Store ID
64096
- * @param {string} documentID Document ID
64097
- * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
63933
+ * Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
63934
+ * @summary Update query suggestions configuration
63935
+ * @param {string} xStoreid Store ID (from dashboard)
63936
+ * @param {string} xStoreWriteSecret Store write secret
63937
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63938
+ * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
64098
63939
  * @param {*} [options] Override http request option.
64099
63940
  * @throws {RequiredError}
64100
63941
  */
64101
- adminStoresXStoreIDDocumentsDocumentIDPut(xStoreID: string, documentID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
63942
+ apiV1StoresXStoreIDQuerySuggestionsConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>;
64102
63943
  /**
64103
- * Retrieves documents from a store with pagination and optional filtering
64104
- * @summary Get documents from store
64105
- * @param {string} xStoreID X-Store ID
64106
- * @param {number} [page] Page number (default: 1)
64107
- * @param {number} [limit] Results per page (default: 20, max: 100)
64108
- * @param {string} [search] Search query
64109
- * @param {string} [filter] JSON filter object
64110
- * @param {string} [sort] Sort field and direction (e.g., \&#39;created_at:desc\&#39;)
63944
+ * Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63945
+ * @summary Get index schema
63946
+ * @param {string} xStoreid Store ID (from dashboard)
63947
+ * @param {string} xStoresecret Store read secret
63948
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64111
63949
  * @param {*} [options] Override http request option.
64112
63950
  * @throws {RequiredError}
64113
63951
  */
64114
- adminStoresXStoreIDDocumentsGet(xStoreID: string, page?: number, limit?: number, search?: string, filter?: string, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentListResponseWrapper>>;
63952
+ apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaResponseWrapper>;
64115
63953
  /**
64116
- * Inserts a new document into a store. If ID is provided, it will be used; otherwise, a hash-based ID will be generated. If a document with the same hash already exists, it will be updated.
64117
- * @summary Insert document
64118
- * @param {string} xStoreID X-Store ID
64119
- * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
63954
+ * Define or update the search index schema (field names, types, searchable/facet options). Mode: `additive` (add fields, keep data) or `replace` (recreate index). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
63955
+ * @summary Create or update index schema
63956
+ * @param {string} xStoreid Store ID (from dashboard)
63957
+ * @param {string} xStoreWriteSecret Store write secret
63958
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63959
+ * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
64120
63960
  * @param {*} [options] Override http request option.
64121
63961
  * @throws {RequiredError}
64122
63962
  */
64123
- adminStoresXStoreIDDocumentsPost(xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
63963
+ apiV1StoresXStoreIDSchemaPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaResponseWrapper>;
64124
63964
  };
64125
63965
  /**
64126
- * StoreDocumentsApi - factory interface
63966
+ * StoreManagementApi - object-oriented interface
64127
63967
  * @export
63968
+ * @class StoreManagementApi
63969
+ * @extends {BaseAPI}
64128
63970
  */
64129
- export declare const StoreDocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
63971
+ export declare class StoreManagementApi extends BaseAPI {
64130
63972
  /**
64131
- *
64132
- * @summary Bulk document operations
64133
- * @param {string} xStoreID X-Store ID
64134
- * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest Bulk operation data
63973
+ * Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
63974
+ * @summary Create Store (Public SDK API)
63975
+ * @param {string} authorization Bearer JWT Token
63976
+ * @param {DataTypesPublicCreateStoreRequest} dataTypesPublicCreateStoreRequest Store creation request
64135
63977
  * @param {*} [options] Override http request option.
64136
63978
  * @throws {RequiredError}
63979
+ * @memberof StoreManagementApi
64137
63980
  */
64138
- adminStoresXStoreIDDocumentsBulkPost(xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesBulkDocumentResponseWrapper>;
63981
+ apiV1StoresPost(authorization: string, dataTypesPublicCreateStoreRequest: DataTypesPublicCreateStoreRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesPublicCreateStoreResponse, any, {}>>;
64139
63982
  /**
64140
- * Deletes a document by ID from a store
64141
- * @summary Delete document
64142
- * @param {string} xStoreID X-Store ID
64143
- * @param {string} documentID Document ID
63983
+ * Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63984
+ * @summary Get store configuration
63985
+ * @param {string} xStoreid Store ID (from dashboard)
63986
+ * @param {string} xStoresecret Store read secret
63987
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64144
63988
  * @param {*} [options] Override http request option.
64145
63989
  * @throws {RequiredError}
63990
+ * @memberof StoreManagementApi
64146
63991
  */
64147
- adminStoresXStoreIDDocumentsDocumentIDDelete(xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
63992
+ apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse, any, {}>>;
64148
63993
  /**
64149
- * Retrieves a single document by ID from a store
64150
- * @summary Get single document
64151
- * @param {string} xStoreID X-Store ID
64152
- * @param {string} documentID Document ID
63994
+ * Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
63995
+ * @summary Update store configuration
63996
+ * @param {string} xStoreid Store ID (from dashboard)
63997
+ * @param {string} xStoreWriteSecret Store write secret
63998
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63999
+ * @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
64153
64000
  * @param {*} [options] Override http request option.
64154
64001
  * @throws {RequiredError}
64002
+ * @memberof StoreManagementApi
64155
64003
  */
64156
- adminStoresXStoreIDDocumentsDocumentIDGet(xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
64004
+ apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesIndexConfigResponseWrapper, any, {}>>;
64157
64005
  /**
64158
- *
64159
- * @summary Update document
64160
- * @param {string} xStoreID X-Store ID
64161
- * @param {string} documentID Document ID
64162
- * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
64006
+ * Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
64007
+ * @summary Get store config schema
64008
+ * @param {string} xStoreid Store ID (from dashboard)
64009
+ * @param {string} xStoresecret Store read secret
64010
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64163
64011
  * @param {*} [options] Override http request option.
64164
64012
  * @throws {RequiredError}
64013
+ * @memberof StoreManagementApi
64165
64014
  */
64166
- adminStoresXStoreIDDocumentsDocumentIDPut(xStoreID: string, documentID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
64015
+ apiV1StoresXStoreIDConfigSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesConfigurationSchemaResponseWrapper, any, {}>>;
64167
64016
  /**
64168
- * Retrieves documents from a store with pagination and optional filtering
64169
- * @summary Get documents from store
64170
- * @param {string} xStoreID X-Store ID
64171
- * @param {number} [page] Page number (default: 1)
64172
- * @param {number} [limit] Results per page (default: 20, max: 100)
64173
- * @param {string} [search] Search query
64174
- * @param {string} [filter] JSON filter object
64175
- * @param {string} [sort] Sort field and direction (e.g., \&#39;created_at:desc\&#39;)
64017
+ * Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. Each item can specify its own action.
64018
+ * @summary Bulk index documents
64019
+ * @param {string} xStoreid Store ID (from dashboard)
64020
+ * @param {string} xStoreWriteSecret Store write secret
64021
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64022
+ * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
64176
64023
  * @param {*} [options] Override http request option.
64177
64024
  * @throws {RequiredError}
64025
+ * @memberof StoreManagementApi
64178
64026
  */
64179
- adminStoresXStoreIDDocumentsGet(xStoreID: string, page?: number, limit?: number, search?: string, filter?: string, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentListResponseWrapper>;
64027
+ apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesBulkDocumentResponseWrapper, any, {}>>;
64180
64028
  /**
64181
- * Inserts a new document into a store. If ID is provided, it will be used; otherwise, a hash-based ID will be generated. If a document with the same hash already exists, it will be updated.
64182
- * @summary Insert document
64183
- * @param {string} xStoreID X-Store ID
64184
- * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
64029
+ * Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
64030
+ * @summary Clear all documents
64031
+ * @param {string} xStoreid Store ID (from dashboard)
64032
+ * @param {string} xStoreWriteSecret Store write secret
64033
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64185
64034
  * @param {*} [options] Override http request option.
64186
64035
  * @throws {RequiredError}
64036
+ * @memberof StoreManagementApi
64187
64037
  */
64188
- adminStoresXStoreIDDocumentsPost(xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
64189
- };
64190
- /**
64191
- * StoreDocumentsApi - object-oriented interface
64192
- * @export
64193
- * @class StoreDocumentsApi
64194
- * @extends {BaseAPI}
64195
- */
64196
- export declare class StoreDocumentsApi extends BaseAPI {
64038
+ apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesClearDocumentsResponseWrapper, any, {}>>;
64197
64039
  /**
64198
- *
64199
- * @summary Bulk document operations
64200
- * @param {string} xStoreID X-Store ID
64201
- * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest Bulk operation data
64040
+ * Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
64041
+ * @summary Delete a document
64042
+ * @param {string} xStoreid Store ID (from dashboard)
64043
+ * @param {string} xStoreWriteSecret Store write secret
64044
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64045
+ * @param {string} documentID Document ID to delete
64202
64046
  * @param {*} [options] Override http request option.
64203
64047
  * @throws {RequiredError}
64204
- * @memberof StoreDocumentsApi
64048
+ * @memberof StoreManagementApi
64205
64049
  */
64206
- adminStoresXStoreIDDocumentsBulkPost(xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesBulkDocumentResponseWrapper, any, {}>>;
64050
+ apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
64207
64051
  /**
64208
- * Deletes a document by ID from a store
64209
- * @summary Delete document
64210
- * @param {string} xStoreID X-Store ID
64211
- * @param {string} documentID Document ID
64052
+ * Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret` (read secret). Path `xStoreID` must match the `x-storeid` header. Used by product pages and PDP.
64053
+ * @summary Get a document by ID
64054
+ * @param {string} xStoreid Store ID (from dashboard)
64055
+ * @param {string} xStoresecret Store read secret
64056
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64057
+ * @param {string} documentID Document ID to retrieve
64212
64058
  * @param {*} [options] Override http request option.
64213
64059
  * @throws {RequiredError}
64214
- * @memberof StoreDocumentsApi
64060
+ * @memberof StoreManagementApi
64215
64061
  */
64216
- adminStoresXStoreIDDocumentsDocumentIDDelete(xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
64062
+ apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
64217
64063
  /**
64218
- * Retrieves a single document by ID from a store
64219
- * @summary Get single document
64220
- * @param {string} xStoreID X-Store ID
64221
- * @param {string} documentID Document ID
64064
+ * Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
64065
+ * @summary Index a single document
64066
+ * @param {string} xStoreid Store ID (from dashboard)
64067
+ * @param {string} xStoreWriteSecret Store write secret
64068
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64069
+ * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
64222
64070
  * @param {*} [options] Override http request option.
64223
64071
  * @throws {RequiredError}
64224
- * @memberof StoreDocumentsApi
64072
+ * @memberof StoreManagementApi
64225
64073
  */
64226
- adminStoresXStoreIDDocumentsDocumentIDGet(xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
64074
+ apiV1StoresXStoreIDDocumentsPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
64227
64075
  /**
64228
- *
64229
- * @summary Update document
64230
- * @param {string} xStoreID X-Store ID
64231
- * @param {string} documentID Document ID
64232
- * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
64076
+ * Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
64077
+ * @summary Get store info
64078
+ * @param {string} xStoreid Store ID (from dashboard)
64079
+ * @param {string} xStoresecret Store read secret
64080
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64233
64081
  * @param {*} [options] Override http request option.
64234
64082
  * @throws {RequiredError}
64235
- * @memberof StoreDocumentsApi
64083
+ * @memberof StoreManagementApi
64236
64084
  */
64237
- adminStoresXStoreIDDocumentsDocumentIDPut(xStoreID: string, documentID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
64085
+ apiV1StoresXStoreIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesPublicStoreInfoResponse, any, {}>>;
64238
64086
  /**
64239
- * Retrieves documents from a store with pagination and optional filtering
64240
- * @summary Get documents from store
64241
- * @param {string} xStoreID X-Store ID
64242
- * @param {number} [page] Page number (default: 1)
64243
- * @param {number} [limit] Results per page (default: 20, max: 100)
64244
- * @param {string} [search] Search query
64245
- * @param {string} [filter] JSON filter object
64246
- * @param {string} [sort] Sort field and direction (e.g., \&#39;created_at:desc\&#39;)
64087
+ * Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
64088
+ * @summary Get query suggestions configuration
64089
+ * @param {string} xStoreid Store ID (from dashboard)
64090
+ * @param {string} xStoresecret Store read secret
64091
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64247
64092
  * @param {*} [options] Override http request option.
64248
64093
  * @throws {RequiredError}
64249
- * @memberof StoreDocumentsApi
64094
+ * @memberof StoreManagementApi
64250
64095
  */
64251
- adminStoresXStoreIDDocumentsGet(xStoreID: string, page?: number, limit?: number, search?: string, filter?: string, sort?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentListResponseWrapper, any, {}>>;
64096
+ apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuerySuggestionsServiceQuerySuggestionsAPIResponse, any, {}>>;
64252
64097
  /**
64253
- * Inserts a new document into a store. If ID is provided, it will be used; otherwise, a hash-based ID will be generated. If a document with the same hash already exists, it will be updated.
64254
- * @summary Insert document
64255
- * @param {string} xStoreID X-Store ID
64256
- * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
64098
+ * Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
64099
+ * @summary Update query suggestions configuration
64100
+ * @param {string} xStoreid Store ID (from dashboard)
64101
+ * @param {string} xStoreWriteSecret Store write secret
64102
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64103
+ * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
64257
64104
  * @param {*} [options] Override http request option.
64258
64105
  * @throws {RequiredError}
64259
- * @memberof StoreDocumentsApi
64106
+ * @memberof StoreManagementApi
64260
64107
  */
64261
- adminStoresXStoreIDDocumentsPost(xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
64108
+ apiV1StoresXStoreIDQuerySuggestionsConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuerySuggestionsServiceQuerySuggestionsAPIResponse, any, {}>>;
64109
+ /**
64110
+ * Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
64111
+ * @summary Get index schema
64112
+ * @param {string} xStoreid Store ID (from dashboard)
64113
+ * @param {string} xStoresecret Store read secret
64114
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64115
+ * @param {*} [options] Override http request option.
64116
+ * @throws {RequiredError}
64117
+ * @memberof StoreManagementApi
64118
+ */
64119
+ apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaResponseWrapper, any, {}>>;
64120
+ /**
64121
+ * Define or update the search index schema (field names, types, searchable/facet options). Mode: `additive` (add fields, keep data) or `replace` (recreate index). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
64122
+ * @summary Create or update index schema
64123
+ * @param {string} xStoreid Store ID (from dashboard)
64124
+ * @param {string} xStoreWriteSecret Store write secret
64125
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64126
+ * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
64127
+ * @param {*} [options] Override http request option.
64128
+ * @throws {RequiredError}
64129
+ * @memberof StoreManagementApi
64130
+ */
64131
+ apiV1StoresXStoreIDSchemaPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaResponseWrapper, any, {}>>;
64262
64132
  }
64263
64133
  /**
64264
64134
  * StoresApi - axios parameter creator