@seekora-ai/admin-api 1.1.86 → 1.1.88
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -16
- package/api.ts +2217 -2394
- package/dist/api.d.ts +912 -1024
- package/dist/api.js +2797 -2987
- package/dist/esm/api.d.ts +912 -1024
- package/dist/esm/api.js +2948 -3118
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.1.88.tgz +0 -0
- package/seekora-ai-admin-api-1.1.86.tgz +0 -0
package/dist/api.d.ts
CHANGED
|
@@ -14778,6 +14778,24 @@ export interface DataTypesCreatePaymentOrderResponse {
|
|
|
14778
14778
|
* @memberof DataTypesCreatePaymentOrderResponse
|
|
14779
14779
|
*/
|
|
14780
14780
|
'status'?: string;
|
|
14781
|
+
/**
|
|
14782
|
+
* Tax breakdown (for frontend checkout display)
|
|
14783
|
+
* @type {number}
|
|
14784
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
14785
|
+
*/
|
|
14786
|
+
'subtotal'?: number;
|
|
14787
|
+
/**
|
|
14788
|
+
* Tax amount
|
|
14789
|
+
* @type {number}
|
|
14790
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
14791
|
+
*/
|
|
14792
|
+
'tax_amount'?: number;
|
|
14793
|
+
/**
|
|
14794
|
+
* Tax rate percentage (e.g. 18.0)
|
|
14795
|
+
* @type {number}
|
|
14796
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
14797
|
+
*/
|
|
14798
|
+
'tax_rate'?: number;
|
|
14781
14799
|
}
|
|
14782
14800
|
/**
|
|
14783
14801
|
*
|
|
@@ -61955,212 +61973,6 @@ export declare class RolesApi extends BaseAPI {
|
|
|
61955
61973
|
*/
|
|
61956
61974
|
adminRolesRoleIdPermissionsPut(roleId: number, dataTypesSlimUpdateRolePermissionsRequest: DataTypesSlimUpdateRolePermissionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
61957
61975
|
}
|
|
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
61976
|
/**
|
|
62165
61977
|
* SDKExperimentsApi - axios parameter creator
|
|
62166
61978
|
* @export
|
|
@@ -62233,575 +62045,269 @@ export declare class SDKExperimentsApi extends BaseAPI {
|
|
|
62233
62045
|
v1ExperimentsAssignmentGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesExperimentAssignmentResponse, any, {}>>;
|
|
62234
62046
|
}
|
|
62235
62047
|
/**
|
|
62236
|
-
*
|
|
62048
|
+
* SearchApi - axios parameter creator
|
|
62237
62049
|
* @export
|
|
62238
62050
|
*/
|
|
62239
|
-
export declare const
|
|
62051
|
+
export declare const SearchApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
62240
62052
|
/**
|
|
62241
|
-
*
|
|
62242
|
-
* @summary
|
|
62243
|
-
* @param {string}
|
|
62244
|
-
* @param {
|
|
62245
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
62053
|
+
* Search documents with combined widget and document data, autocomplete suggestions, and configurable stopwords/synonyms
|
|
62054
|
+
* @summary Admin Search API
|
|
62055
|
+
* @param {string} xStoreID X-Store ID
|
|
62056
|
+
* @param {DataTypesAdminSearchRequest} dataTypesAdminSearchRequest Admin search request with optional stopword_sets and synonym_sets for granular control
|
|
62246
62057
|
* @param {*} [options] Override http request option.
|
|
62247
62058
|
* @throws {RequiredError}
|
|
62248
62059
|
*/
|
|
62249
|
-
|
|
62060
|
+
adminV1SearchXStoreIDPost: (xStoreID: string, dataTypesAdminSearchRequest: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
62250
62061
|
/**
|
|
62251
|
-
*
|
|
62252
|
-
* @summary
|
|
62253
|
-
* @param {string}
|
|
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)
|
|
62062
|
+
* Get metadata about all configurable fields for dynamic form generation
|
|
62063
|
+
* @summary Get Configuration Schema
|
|
62064
|
+
* @param {string} [indexname] Index name to get field options from
|
|
62257
62065
|
* @param {*} [options] Override http request option.
|
|
62258
62066
|
* @throws {RequiredError}
|
|
62259
62067
|
*/
|
|
62260
|
-
|
|
62261
|
-
};
|
|
62262
|
-
/**
|
|
62263
|
-
* SDKQuerySuggestionsConfigApi - functional programming interface
|
|
62264
|
-
* @export
|
|
62265
|
-
*/
|
|
62266
|
-
export declare const SDKQuerySuggestionsConfigApiFp: (configuration?: Configuration) => {
|
|
62068
|
+
v1IndexConfigSchemaGet: (indexname?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
62267
62069
|
/**
|
|
62268
|
-
*
|
|
62269
|
-
* @summary Get
|
|
62270
|
-
* @param {string}
|
|
62271
|
-
* @param {string} xStoresecret Store read secret
|
|
62272
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
62070
|
+
* Get the current index configuration
|
|
62071
|
+
* @summary Get Index Config
|
|
62072
|
+
* @param {string} indexname Index Name
|
|
62273
62073
|
* @param {*} [options] Override http request option.
|
|
62274
62074
|
* @throws {RequiredError}
|
|
62275
62075
|
*/
|
|
62276
|
-
|
|
62076
|
+
v1IndexIndexnameConfigGet: (indexname: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
62277
62077
|
/**
|
|
62278
|
-
*
|
|
62279
|
-
* @summary
|
|
62280
|
-
* @param {string}
|
|
62281
|
-
* @param {
|
|
62282
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
62283
|
-
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
62078
|
+
* Configure the index for search
|
|
62079
|
+
* @summary Index Config
|
|
62080
|
+
* @param {string} indexname Index Name
|
|
62081
|
+
* @param {DataTypesIndexConfig} dataTypesIndexConfig Index configuration
|
|
62284
62082
|
* @param {*} [options] Override http request option.
|
|
62285
62083
|
* @throws {RequiredError}
|
|
62286
62084
|
*/
|
|
62287
|
-
|
|
62288
|
-
};
|
|
62289
|
-
/**
|
|
62290
|
-
* SDKQuerySuggestionsConfigApi - factory interface
|
|
62291
|
-
* @export
|
|
62292
|
-
*/
|
|
62293
|
-
export declare const SDKQuerySuggestionsConfigApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
62085
|
+
v1IndexIndexnameConfigPost: (indexname: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
62294
62086
|
/**
|
|
62295
|
-
*
|
|
62296
|
-
* @summary
|
|
62087
|
+
* Update a single property of the index configuration
|
|
62088
|
+
* @summary Update Index Config Property
|
|
62089
|
+
* @param {string} indexname Index Name
|
|
62090
|
+
* @param {string} property Property name
|
|
62091
|
+
* @param {object} body Property value
|
|
62092
|
+
* @param {*} [options] Override http request option.
|
|
62093
|
+
* @throws {RequiredError}
|
|
62094
|
+
*/
|
|
62095
|
+
v1IndexIndexnameConfigPropertyPatch: (indexname: string, property: string, body: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
62096
|
+
/**
|
|
62097
|
+
* Get default configuration values computed from the Typesense schema
|
|
62098
|
+
* @summary Get Schema-Based Defaults
|
|
62099
|
+
* @param {string} indexname Index Name
|
|
62100
|
+
* @param {*} [options] Override http request option.
|
|
62101
|
+
* @throws {RequiredError}
|
|
62102
|
+
*/
|
|
62103
|
+
v1IndexIndexnameDefaultsGet: (indexname: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
62104
|
+
/**
|
|
62105
|
+
* 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.
|
|
62106
|
+
* @summary Search (GET)
|
|
62297
62107
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
62298
|
-
* @param {string} xStoresecret Store read secret
|
|
62299
|
-
* @param {string}
|
|
62108
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
62109
|
+
* @param {string} q Search query
|
|
62110
|
+
* @param {string} [xUserId] User ID for personalization
|
|
62111
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
62112
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
62113
|
+
* @param {number} [page] Page number (default: 1)
|
|
62114
|
+
* @param {number} [perPage] Items per page (default: 10)
|
|
62115
|
+
* @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
|
|
62116
|
+
* @param {string} [filterBy] Filter string (e.g., category:shirts)
|
|
62117
|
+
* @param {string} [facetBy] Facet fields (comma-separated)
|
|
62118
|
+
* @param {number} [maxFacetValues] Maximum facet values to return
|
|
62119
|
+
* @param {boolean} [widgetMode] Return widget-formatted results
|
|
62120
|
+
* @param {boolean} [includeSuggestions] Include autocomplete suggestions
|
|
62121
|
+
* @param {number} [suggestionsLimit] Number of suggestions to return
|
|
62122
|
+
* @param {string} [analyticsTags] Analytics tags (comma-separated)
|
|
62123
|
+
* @param {string} [stopwordSets] Stopword set IDs (comma-separated)
|
|
62124
|
+
* @param {string} [synonymSets] Synonym set IDs (comma-separated)
|
|
62125
|
+
* @param {string} [searchFields] Fields to search in (comma-separated)
|
|
62126
|
+
* @param {string} [returnFields] Fields to return (comma-separated)
|
|
62127
|
+
* @param {string} [omitFields] Fields to omit (comma-separated)
|
|
62128
|
+
* @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
|
|
62129
|
+
* @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
|
|
62130
|
+
* @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
|
|
62131
|
+
* @param {string} [groupField] Field to group results by
|
|
62132
|
+
* @param {number} [groupSize] Number of results per group
|
|
62133
|
+
* @param {string} [snippetPrefix] Prefix for highlighted snippets
|
|
62134
|
+
* @param {string} [snippetSuffix] Suffix for highlighted snippets
|
|
62135
|
+
* @param {number} [snippetTokenLimit] Maximum tokens in snippet
|
|
62136
|
+
* @param {number} [snippetMinLen] Minimum snippet length
|
|
62137
|
+
* @param {boolean} [includeSnippets] Include snippets in results
|
|
62138
|
+
* @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
|
|
62139
|
+
* @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
|
|
62140
|
+
* @param {number} [typoMax] Maximum typo tolerance
|
|
62141
|
+
* @param {number} [typoMinLen1] Min word length for 1 typo
|
|
62142
|
+
* @param {number} [typoMinLen2] Min word length for 2 typos
|
|
62143
|
+
* @param {number} [searchTimeoutMs] Search timeout in milliseconds
|
|
62144
|
+
* @param {boolean} [requireAllTerms] Require all search terms to match
|
|
62145
|
+
* @param {boolean} [exactMatchBoost] Boost exact matches
|
|
62146
|
+
* @param {boolean} [cacheResults] Cache search results
|
|
62147
|
+
* @param {boolean} [applyRules] Apply search rules
|
|
62148
|
+
* @param {string} [presetName] Search preset name to use
|
|
62149
|
+
* @param {string} [facetSearchText] Text to filter facet values
|
|
62300
62150
|
* @param {*} [options] Override http request option.
|
|
62301
62151
|
* @throws {RequiredError}
|
|
62302
62152
|
*/
|
|
62303
|
-
|
|
62153
|
+
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>;
|
|
62304
62154
|
/**
|
|
62305
|
-
*
|
|
62306
|
-
* @summary
|
|
62155
|
+
* 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.
|
|
62156
|
+
* @summary Search (POST)
|
|
62307
62157
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
62308
|
-
* @param {string}
|
|
62309
|
-
* @param {
|
|
62310
|
-
* @param {
|
|
62158
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
62159
|
+
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
|
|
62160
|
+
* @param {string} [xUserId] User ID for personalization
|
|
62161
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
62162
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
62311
62163
|
* @param {*} [options] Override http request option.
|
|
62312
62164
|
* @throws {RequiredError}
|
|
62313
62165
|
*/
|
|
62314
|
-
|
|
62166
|
+
v1SearchPost: (xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
62315
62167
|
};
|
|
62316
62168
|
/**
|
|
62317
|
-
*
|
|
62169
|
+
* SearchApi - functional programming interface
|
|
62318
62170
|
* @export
|
|
62319
|
-
* @class SDKQuerySuggestionsConfigApi
|
|
62320
|
-
* @extends {BaseAPI}
|
|
62321
62171
|
*/
|
|
62322
|
-
export declare
|
|
62172
|
+
export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
62323
62173
|
/**
|
|
62324
|
-
*
|
|
62325
|
-
* @summary
|
|
62326
|
-
* @param {string}
|
|
62327
|
-
* @param {
|
|
62328
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
62174
|
+
* Search documents with combined widget and document data, autocomplete suggestions, and configurable stopwords/synonyms
|
|
62175
|
+
* @summary Admin Search API
|
|
62176
|
+
* @param {string} xStoreID X-Store ID
|
|
62177
|
+
* @param {DataTypesAdminSearchRequest} dataTypesAdminSearchRequest Admin search request with optional stopword_sets and synonym_sets for granular control
|
|
62329
62178
|
* @param {*} [options] Override http request option.
|
|
62330
62179
|
* @throws {RequiredError}
|
|
62331
|
-
* @memberof SDKQuerySuggestionsConfigApi
|
|
62332
62180
|
*/
|
|
62333
|
-
|
|
62181
|
+
adminV1SearchXStoreIDPost(xStoreID: string, dataTypesAdminSearchRequest: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesCombinedSearchResponseWrapper>>;
|
|
62334
62182
|
/**
|
|
62335
|
-
*
|
|
62336
|
-
* @summary
|
|
62337
|
-
* @param {string}
|
|
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)
|
|
62183
|
+
* Get metadata about all configurable fields for dynamic form generation
|
|
62184
|
+
* @summary Get Configuration Schema
|
|
62185
|
+
* @param {string} [indexname] Index name to get field options from
|
|
62341
62186
|
* @param {*} [options] Override http request option.
|
|
62342
62187
|
* @throws {RequiredError}
|
|
62343
|
-
* @memberof SDKQuerySuggestionsConfigApi
|
|
62344
62188
|
*/
|
|
62345
|
-
|
|
62346
|
-
}
|
|
62347
|
-
/**
|
|
62348
|
-
* SDKSchemaApi - axios parameter creator
|
|
62349
|
-
* @export
|
|
62350
|
-
*/
|
|
62351
|
-
export declare const SDKSchemaApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
62189
|
+
v1IndexConfigSchemaGet(indexname?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>>;
|
|
62352
62190
|
/**
|
|
62353
|
-
*
|
|
62354
|
-
* @summary
|
|
62355
|
-
* @param {string}
|
|
62356
|
-
* @param {string} xStoreWriteSecret Store write secret
|
|
62357
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
62191
|
+
* Get the current index configuration
|
|
62192
|
+
* @summary Get Index Config
|
|
62193
|
+
* @param {string} indexname Index Name
|
|
62358
62194
|
* @param {*} [options] Override http request option.
|
|
62359
62195
|
* @throws {RequiredError}
|
|
62360
62196
|
*/
|
|
62361
|
-
|
|
62197
|
+
v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponseWrapper>>;
|
|
62362
62198
|
/**
|
|
62363
|
-
*
|
|
62364
|
-
* @summary
|
|
62365
|
-
* @param {string}
|
|
62366
|
-
* @param {
|
|
62367
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
62199
|
+
* Configure the index for search
|
|
62200
|
+
* @summary Index Config
|
|
62201
|
+
* @param {string} indexname Index Name
|
|
62202
|
+
* @param {DataTypesIndexConfig} dataTypesIndexConfig Index configuration
|
|
62368
62203
|
* @param {*} [options] Override http request option.
|
|
62369
62204
|
* @throws {RequiredError}
|
|
62370
62205
|
*/
|
|
62371
|
-
|
|
62206
|
+
v1IndexIndexnameConfigPost(indexname: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
62372
62207
|
/**
|
|
62373
|
-
*
|
|
62374
|
-
* @summary
|
|
62375
|
-
* @param {string}
|
|
62376
|
-
* @param {string}
|
|
62377
|
-
* @param {
|
|
62378
|
-
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
62208
|
+
* Update a single property of the index configuration
|
|
62209
|
+
* @summary Update Index Config Property
|
|
62210
|
+
* @param {string} indexname Index Name
|
|
62211
|
+
* @param {string} property Property name
|
|
62212
|
+
* @param {object} body Property value
|
|
62379
62213
|
* @param {*} [options] Override http request option.
|
|
62380
62214
|
* @throws {RequiredError}
|
|
62381
62215
|
*/
|
|
62382
|
-
|
|
62383
|
-
};
|
|
62384
|
-
/**
|
|
62385
|
-
* SDKSchemaApi - functional programming interface
|
|
62386
|
-
* @export
|
|
62387
|
-
*/
|
|
62388
|
-
export declare const SDKSchemaApiFp: (configuration?: Configuration) => {
|
|
62216
|
+
v1IndexIndexnameConfigPropertyPatch(indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
62389
62217
|
/**
|
|
62390
|
-
*
|
|
62391
|
-
* @summary
|
|
62392
|
-
* @param {string}
|
|
62393
|
-
* @param {string} xStoreWriteSecret Store write secret
|
|
62394
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
62218
|
+
* Get default configuration values computed from the Typesense schema
|
|
62219
|
+
* @summary Get Schema-Based Defaults
|
|
62220
|
+
* @param {string} indexname Index Name
|
|
62395
62221
|
* @param {*} [options] Override http request option.
|
|
62396
62222
|
* @throws {RequiredError}
|
|
62397
62223
|
*/
|
|
62398
|
-
|
|
62224
|
+
v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>>;
|
|
62399
62225
|
/**
|
|
62400
|
-
*
|
|
62401
|
-
* @summary
|
|
62226
|
+
* 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.
|
|
62227
|
+
* @summary Search (GET)
|
|
62402
62228
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
62403
|
-
* @param {string} xStoresecret Store read secret
|
|
62404
|
-
* @param {string}
|
|
62229
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
62230
|
+
* @param {string} q Search query
|
|
62231
|
+
* @param {string} [xUserId] User ID for personalization
|
|
62232
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
62233
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
62234
|
+
* @param {number} [page] Page number (default: 1)
|
|
62235
|
+
* @param {number} [perPage] Items per page (default: 10)
|
|
62236
|
+
* @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
|
|
62237
|
+
* @param {string} [filterBy] Filter string (e.g., category:shirts)
|
|
62238
|
+
* @param {string} [facetBy] Facet fields (comma-separated)
|
|
62239
|
+
* @param {number} [maxFacetValues] Maximum facet values to return
|
|
62240
|
+
* @param {boolean} [widgetMode] Return widget-formatted results
|
|
62241
|
+
* @param {boolean} [includeSuggestions] Include autocomplete suggestions
|
|
62242
|
+
* @param {number} [suggestionsLimit] Number of suggestions to return
|
|
62243
|
+
* @param {string} [analyticsTags] Analytics tags (comma-separated)
|
|
62244
|
+
* @param {string} [stopwordSets] Stopword set IDs (comma-separated)
|
|
62245
|
+
* @param {string} [synonymSets] Synonym set IDs (comma-separated)
|
|
62246
|
+
* @param {string} [searchFields] Fields to search in (comma-separated)
|
|
62247
|
+
* @param {string} [returnFields] Fields to return (comma-separated)
|
|
62248
|
+
* @param {string} [omitFields] Fields to omit (comma-separated)
|
|
62249
|
+
* @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
|
|
62250
|
+
* @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
|
|
62251
|
+
* @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
|
|
62252
|
+
* @param {string} [groupField] Field to group results by
|
|
62253
|
+
* @param {number} [groupSize] Number of results per group
|
|
62254
|
+
* @param {string} [snippetPrefix] Prefix for highlighted snippets
|
|
62255
|
+
* @param {string} [snippetSuffix] Suffix for highlighted snippets
|
|
62256
|
+
* @param {number} [snippetTokenLimit] Maximum tokens in snippet
|
|
62257
|
+
* @param {number} [snippetMinLen] Minimum snippet length
|
|
62258
|
+
* @param {boolean} [includeSnippets] Include snippets in results
|
|
62259
|
+
* @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
|
|
62260
|
+
* @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
|
|
62261
|
+
* @param {number} [typoMax] Maximum typo tolerance
|
|
62262
|
+
* @param {number} [typoMinLen1] Min word length for 1 typo
|
|
62263
|
+
* @param {number} [typoMinLen2] Min word length for 2 typos
|
|
62264
|
+
* @param {number} [searchTimeoutMs] Search timeout in milliseconds
|
|
62265
|
+
* @param {boolean} [requireAllTerms] Require all search terms to match
|
|
62266
|
+
* @param {boolean} [exactMatchBoost] Boost exact matches
|
|
62267
|
+
* @param {boolean} [cacheResults] Cache search results
|
|
62268
|
+
* @param {boolean} [applyRules] Apply search rules
|
|
62269
|
+
* @param {string} [presetName] Search preset name to use
|
|
62270
|
+
* @param {string} [facetSearchText] Text to filter facet values
|
|
62405
62271
|
* @param {*} [options] Override http request option.
|
|
62406
62272
|
* @throws {RequiredError}
|
|
62407
62273
|
*/
|
|
62408
|
-
|
|
62274
|
+
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
62275
|
/**
|
|
62410
|
-
*
|
|
62411
|
-
* @summary
|
|
62276
|
+
* 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.
|
|
62277
|
+
* @summary Search (POST)
|
|
62412
62278
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
62413
|
-
* @param {string}
|
|
62414
|
-
* @param {
|
|
62415
|
-
* @param {
|
|
62279
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
62280
|
+
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
|
|
62281
|
+
* @param {string} [xUserId] User ID for personalization
|
|
62282
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
62283
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
62416
62284
|
* @param {*} [options] Override http request option.
|
|
62417
62285
|
* @throws {RequiredError}
|
|
62418
62286
|
*/
|
|
62419
|
-
|
|
62287
|
+
v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOfficialSearchResponseWrapper>>;
|
|
62420
62288
|
};
|
|
62421
62289
|
/**
|
|
62422
|
-
*
|
|
62290
|
+
* SearchApi - factory interface
|
|
62423
62291
|
* @export
|
|
62424
62292
|
*/
|
|
62425
|
-
export declare const
|
|
62293
|
+
export declare const SearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
62426
62294
|
/**
|
|
62427
|
-
*
|
|
62428
|
-
* @summary
|
|
62429
|
-
* @param {string}
|
|
62430
|
-
* @param {
|
|
62431
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
62295
|
+
* Search documents with combined widget and document data, autocomplete suggestions, and configurable stopwords/synonyms
|
|
62296
|
+
* @summary Admin Search API
|
|
62297
|
+
* @param {string} xStoreID X-Store ID
|
|
62298
|
+
* @param {DataTypesAdminSearchRequest} dataTypesAdminSearchRequest Admin search request with optional stopword_sets and synonym_sets for granular control
|
|
62432
62299
|
* @param {*} [options] Override http request option.
|
|
62433
62300
|
* @throws {RequiredError}
|
|
62434
62301
|
*/
|
|
62435
|
-
|
|
62302
|
+
adminV1SearchXStoreIDPost(xStoreID: string, dataTypesAdminSearchRequest: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesCombinedSearchResponseWrapper>;
|
|
62436
62303
|
/**
|
|
62437
|
-
*
|
|
62438
|
-
* @summary Get
|
|
62439
|
-
* @param {string}
|
|
62440
|
-
* @param {string} xStoresecret Store read secret
|
|
62441
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
62304
|
+
* Get metadata about all configurable fields for dynamic form generation
|
|
62305
|
+
* @summary Get Configuration Schema
|
|
62306
|
+
* @param {string} [indexname] Index name to get field options from
|
|
62442
62307
|
* @param {*} [options] Override http request option.
|
|
62443
62308
|
* @throws {RequiredError}
|
|
62444
62309
|
*/
|
|
62445
|
-
|
|
62446
|
-
/**
|
|
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
|
|
62453
|
-
* @param {*} [options] Override http request option.
|
|
62454
|
-
* @throws {RequiredError}
|
|
62455
|
-
*/
|
|
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 {
|
|
62465
|
-
/**
|
|
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)
|
|
62471
|
-
* @param {*} [options] Override http request option.
|
|
62472
|
-
* @throws {RequiredError}
|
|
62473
|
-
* @memberof SDKSchemaApi
|
|
62474
|
-
*/
|
|
62475
|
-
apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesClearDocumentsResponseWrapper, any, {}>>;
|
|
62476
|
-
/**
|
|
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
|
|
62479
|
-
* @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)
|
|
62482
|
-
* @param {*} [options] Override http request option.
|
|
62483
|
-
* @throws {RequiredError}
|
|
62484
|
-
* @memberof SDKSchemaApi
|
|
62485
|
-
*/
|
|
62486
|
-
apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaResponseWrapper, any, {}>>;
|
|
62487
|
-
/**
|
|
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
|
|
62490
|
-
* @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
|
|
62494
|
-
* @param {*} [options] Override http request option.
|
|
62495
|
-
* @throws {RequiredError}
|
|
62496
|
-
* @memberof SDKSchemaApi
|
|
62497
|
-
*/
|
|
62498
|
-
apiV1StoresXStoreIDSchemaPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaResponseWrapper, any, {}>>;
|
|
62499
|
-
}
|
|
62500
|
-
/**
|
|
62501
|
-
* SDKStoreConfigApi - axios parameter creator
|
|
62502
|
-
* @export
|
|
62503
|
-
*/
|
|
62504
|
-
export declare const SDKStoreConfigApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
62505
|
-
/**
|
|
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)
|
|
62511
|
-
* @param {*} [options] Override http request option.
|
|
62512
|
-
* @throws {RequiredError}
|
|
62513
|
-
*/
|
|
62514
|
-
apiV1StoresXStoreIDConfigGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
62515
|
-
/**
|
|
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)
|
|
62522
|
-
* @param {*} [options] Override http request option.
|
|
62523
|
-
* @throws {RequiredError}
|
|
62524
|
-
*/
|
|
62525
|
-
apiV1StoresXStoreIDConfigPut: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
62526
|
-
/**
|
|
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)
|
|
62532
|
-
* @param {*} [options] Override http request option.
|
|
62533
|
-
* @throws {RequiredError}
|
|
62534
|
-
*/
|
|
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) => {
|
|
62542
|
-
/**
|
|
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)
|
|
62548
|
-
* @param {*} [options] Override http request option.
|
|
62549
|
-
* @throws {RequiredError}
|
|
62550
|
-
*/
|
|
62551
|
-
apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse>>;
|
|
62552
|
-
/**
|
|
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
|
|
62555
|
-
* @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)
|
|
62559
|
-
* @param {*} [options] Override http request option.
|
|
62560
|
-
* @throws {RequiredError}
|
|
62561
|
-
*/
|
|
62562
|
-
apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponseWrapper>>;
|
|
62563
|
-
/**
|
|
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
|
|
62566
|
-
* @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)
|
|
62569
|
-
* @param {*} [options] Override http request option.
|
|
62570
|
-
* @throws {RequiredError}
|
|
62571
|
-
*/
|
|
62572
|
-
apiV1StoresXStoreIDConfigSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>>;
|
|
62573
|
-
};
|
|
62574
|
-
/**
|
|
62575
|
-
* SDKStoreConfigApi - factory interface
|
|
62576
|
-
* @export
|
|
62577
|
-
*/
|
|
62578
|
-
export declare const SDKStoreConfigApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
62579
|
-
/**
|
|
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)
|
|
62585
|
-
* @param {*} [options] Override http request option.
|
|
62586
|
-
* @throws {RequiredError}
|
|
62587
|
-
*/
|
|
62588
|
-
apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse>;
|
|
62589
|
-
/**
|
|
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)
|
|
62596
|
-
* @param {*} [options] Override http request option.
|
|
62597
|
-
* @throws {RequiredError}
|
|
62598
|
-
*/
|
|
62599
|
-
apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponseWrapper>;
|
|
62600
|
-
/**
|
|
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)
|
|
62606
|
-
* @param {*} [options] Override http request option.
|
|
62607
|
-
* @throws {RequiredError}
|
|
62608
|
-
*/
|
|
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 {
|
|
62618
|
-
/**
|
|
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)
|
|
62624
|
-
* @param {*} [options] Override http request option.
|
|
62625
|
-
* @throws {RequiredError}
|
|
62626
|
-
* @memberof SDKStoreConfigApi
|
|
62627
|
-
*/
|
|
62628
|
-
apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse, any, {}>>;
|
|
62629
|
-
/**
|
|
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)
|
|
62636
|
-
* @param {*} [options] Override http request option.
|
|
62637
|
-
* @throws {RequiredError}
|
|
62638
|
-
* @memberof SDKStoreConfigApi
|
|
62639
|
-
*/
|
|
62640
|
-
apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesIndexConfigResponseWrapper, any, {}>>;
|
|
62641
|
-
/**
|
|
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)
|
|
62647
|
-
* @param {*} [options] Override http request option.
|
|
62648
|
-
* @throws {RequiredError}
|
|
62649
|
-
* @memberof SDKStoreConfigApi
|
|
62650
|
-
*/
|
|
62651
|
-
apiV1StoresXStoreIDConfigSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesConfigurationSchemaResponseWrapper, any, {}>>;
|
|
62652
|
-
}
|
|
62653
|
-
/**
|
|
62654
|
-
* SDKStoreCreationApi - axios parameter creator
|
|
62655
|
-
* @export
|
|
62656
|
-
*/
|
|
62657
|
-
export declare const SDKStoreCreationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
62658
|
-
/**
|
|
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
|
|
62663
|
-
* @param {*} [options] Override http request option.
|
|
62664
|
-
* @throws {RequiredError}
|
|
62665
|
-
*/
|
|
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) => {
|
|
62673
|
-
/**
|
|
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
|
|
62678
|
-
* @param {*} [options] Override http request option.
|
|
62679
|
-
* @throws {RequiredError}
|
|
62680
|
-
*/
|
|
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) => {
|
|
62688
|
-
/**
|
|
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
|
|
62693
|
-
* @param {*} [options] Override http request option.
|
|
62694
|
-
* @throws {RequiredError}
|
|
62695
|
-
*/
|
|
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 {
|
|
62705
|
-
/**
|
|
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
|
|
62710
|
-
* @param {*} [options] Override http request option.
|
|
62711
|
-
* @throws {RequiredError}
|
|
62712
|
-
* @memberof SDKStoreCreationApi
|
|
62713
|
-
*/
|
|
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) => {
|
|
62721
|
-
/**
|
|
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)
|
|
62727
|
-
* @param {*} [options] Override http request option.
|
|
62728
|
-
* @throws {RequiredError}
|
|
62729
|
-
*/
|
|
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) => {
|
|
62737
|
-
/**
|
|
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)
|
|
62743
|
-
* @param {*} [options] Override http request option.
|
|
62744
|
-
* @throws {RequiredError}
|
|
62745
|
-
*/
|
|
62746
|
-
apiV1StoresXStoreIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesPublicStoreInfoResponse>>;
|
|
62747
|
-
};
|
|
62748
|
-
/**
|
|
62749
|
-
* SDKStoreInfoApi - factory interface
|
|
62750
|
-
* @export
|
|
62751
|
-
*/
|
|
62752
|
-
export declare const SDKStoreInfoApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
62753
|
-
/**
|
|
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)
|
|
62759
|
-
* @param {*} [options] Override http request option.
|
|
62760
|
-
* @throws {RequiredError}
|
|
62761
|
-
*/
|
|
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 {
|
|
62771
|
-
/**
|
|
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)
|
|
62777
|
-
* @param {*} [options] Override http request option.
|
|
62778
|
-
* @throws {RequiredError}
|
|
62779
|
-
* @memberof SDKStoreInfoApi
|
|
62780
|
-
*/
|
|
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) => {
|
|
62788
|
-
/**
|
|
62789
|
-
* Search documents with combined widget and document data, autocomplete suggestions, and configurable stopwords/synonyms
|
|
62790
|
-
* @summary Admin Search API
|
|
62791
|
-
* @param {string} xStoreID X-Store ID
|
|
62792
|
-
* @param {DataTypesAdminSearchRequest} dataTypesAdminSearchRequest Admin search request with optional stopword_sets and synonym_sets for granular control
|
|
62793
|
-
* @param {*} [options] Override http request option.
|
|
62794
|
-
* @throws {RequiredError}
|
|
62795
|
-
*/
|
|
62796
|
-
adminV1SearchXStoreIDPost: (xStoreID: string, dataTypesAdminSearchRequest: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
62797
|
-
/**
|
|
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
|
|
62801
|
-
* @param {*} [options] Override http request option.
|
|
62802
|
-
* @throws {RequiredError}
|
|
62803
|
-
*/
|
|
62804
|
-
v1IndexConfigSchemaGet: (indexname?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
62310
|
+
v1IndexConfigSchemaGet(indexname?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>;
|
|
62805
62311
|
/**
|
|
62806
62312
|
* Get the current index configuration
|
|
62807
62313
|
* @summary Get Index Config
|
|
@@ -62809,7 +62315,7 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
62809
62315
|
* @param {*} [options] Override http request option.
|
|
62810
62316
|
* @throws {RequiredError}
|
|
62811
62317
|
*/
|
|
62812
|
-
v1IndexIndexnameConfigGet
|
|
62318
|
+
v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponseWrapper>;
|
|
62813
62319
|
/**
|
|
62814
62320
|
* Configure the index for search
|
|
62815
62321
|
* @summary Index Config
|
|
@@ -62818,7 +62324,7 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
62818
62324
|
* @param {*} [options] Override http request option.
|
|
62819
62325
|
* @throws {RequiredError}
|
|
62820
62326
|
*/
|
|
62821
|
-
v1IndexIndexnameConfigPost
|
|
62327
|
+
v1IndexIndexnameConfigPost(indexname: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
62822
62328
|
/**
|
|
62823
62329
|
* Update a single property of the index configuration
|
|
62824
62330
|
* @summary Update Index Config Property
|
|
@@ -62828,7 +62334,7 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
62828
62334
|
* @param {*} [options] Override http request option.
|
|
62829
62335
|
* @throws {RequiredError}
|
|
62830
62336
|
*/
|
|
62831
|
-
v1IndexIndexnameConfigPropertyPatch
|
|
62337
|
+
v1IndexIndexnameConfigPropertyPatch(indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
62832
62338
|
/**
|
|
62833
62339
|
* Get default configuration values computed from the Typesense schema
|
|
62834
62340
|
* @summary Get Schema-Based Defaults
|
|
@@ -62836,7 +62342,7 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
62836
62342
|
* @param {*} [options] Override http request option.
|
|
62837
62343
|
* @throws {RequiredError}
|
|
62838
62344
|
*/
|
|
62839
|
-
v1IndexIndexnameDefaultsGet
|
|
62345
|
+
v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>;
|
|
62840
62346
|
/**
|
|
62841
62347
|
* 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
62348
|
* @summary Search (GET)
|
|
@@ -62886,7 +62392,7 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
62886
62392
|
* @param {*} [options] Override http request option.
|
|
62887
62393
|
* @throws {RequiredError}
|
|
62888
62394
|
*/
|
|
62889
|
-
v1SearchGet
|
|
62395
|
+
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>;
|
|
62890
62396
|
/**
|
|
62891
62397
|
* 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
62398
|
* @summary Search (POST)
|
|
@@ -62899,13 +62405,15 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
62899
62405
|
* @param {*} [options] Override http request option.
|
|
62900
62406
|
* @throws {RequiredError}
|
|
62901
62407
|
*/
|
|
62902
|
-
v1SearchPost
|
|
62408
|
+
v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOfficialSearchResponseWrapper>;
|
|
62903
62409
|
};
|
|
62904
62410
|
/**
|
|
62905
|
-
* SearchApi -
|
|
62411
|
+
* SearchApi - object-oriented interface
|
|
62906
62412
|
* @export
|
|
62413
|
+
* @class SearchApi
|
|
62414
|
+
* @extends {BaseAPI}
|
|
62907
62415
|
*/
|
|
62908
|
-
export declare
|
|
62416
|
+
export declare class SearchApi extends BaseAPI {
|
|
62909
62417
|
/**
|
|
62910
62418
|
* Search documents with combined widget and document data, autocomplete suggestions, and configurable stopwords/synonyms
|
|
62911
62419
|
* @summary Admin Search API
|
|
@@ -62913,24 +62421,27 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
|
62913
62421
|
* @param {DataTypesAdminSearchRequest} dataTypesAdminSearchRequest Admin search request with optional stopword_sets and synonym_sets for granular control
|
|
62914
62422
|
* @param {*} [options] Override http request option.
|
|
62915
62423
|
* @throws {RequiredError}
|
|
62424
|
+
* @memberof SearchApi
|
|
62916
62425
|
*/
|
|
62917
|
-
adminV1SearchXStoreIDPost(xStoreID: string, dataTypesAdminSearchRequest: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios
|
|
62426
|
+
adminV1SearchXStoreIDPost(xStoreID: string, dataTypesAdminSearchRequest: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesCombinedSearchResponseWrapper, any, {}>>;
|
|
62918
62427
|
/**
|
|
62919
62428
|
* Get metadata about all configurable fields for dynamic form generation
|
|
62920
62429
|
* @summary Get Configuration Schema
|
|
62921
62430
|
* @param {string} [indexname] Index name to get field options from
|
|
62922
62431
|
* @param {*} [options] Override http request option.
|
|
62923
62432
|
* @throws {RequiredError}
|
|
62433
|
+
* @memberof SearchApi
|
|
62924
62434
|
*/
|
|
62925
|
-
v1IndexConfigSchemaGet(indexname?: string, options?: RawAxiosRequestConfig): Promise<(axios
|
|
62435
|
+
v1IndexConfigSchemaGet(indexname?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesConfigurationSchemaResponseWrapper, any, {}>>;
|
|
62926
62436
|
/**
|
|
62927
62437
|
* Get the current index configuration
|
|
62928
62438
|
* @summary Get Index Config
|
|
62929
62439
|
* @param {string} indexname Index Name
|
|
62930
62440
|
* @param {*} [options] Override http request option.
|
|
62931
62441
|
* @throws {RequiredError}
|
|
62442
|
+
* @memberof SearchApi
|
|
62932
62443
|
*/
|
|
62933
|
-
v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios
|
|
62444
|
+
v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesIndexConfigResponseWrapper, any, {}>>;
|
|
62934
62445
|
/**
|
|
62935
62446
|
* Configure the index for search
|
|
62936
62447
|
* @summary Index Config
|
|
@@ -62938,8 +62449,9 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
|
62938
62449
|
* @param {DataTypesIndexConfig} dataTypesIndexConfig Index configuration
|
|
62939
62450
|
* @param {*} [options] Override http request option.
|
|
62940
62451
|
* @throws {RequiredError}
|
|
62452
|
+
* @memberof SearchApi
|
|
62941
62453
|
*/
|
|
62942
|
-
v1IndexIndexnameConfigPost(indexname: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<(axios
|
|
62454
|
+
v1IndexIndexnameConfigPost(indexname: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
62943
62455
|
/**
|
|
62944
62456
|
* Update a single property of the index configuration
|
|
62945
62457
|
* @summary Update Index Config Property
|
|
@@ -62948,16 +62460,18 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
|
62948
62460
|
* @param {object} body Property value
|
|
62949
62461
|
* @param {*} [options] Override http request option.
|
|
62950
62462
|
* @throws {RequiredError}
|
|
62463
|
+
* @memberof SearchApi
|
|
62951
62464
|
*/
|
|
62952
|
-
v1IndexIndexnameConfigPropertyPatch(indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): Promise<(axios
|
|
62465
|
+
v1IndexIndexnameConfigPropertyPatch(indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
62953
62466
|
/**
|
|
62954
62467
|
* Get default configuration values computed from the Typesense schema
|
|
62955
62468
|
* @summary Get Schema-Based Defaults
|
|
62956
62469
|
* @param {string} indexname Index Name
|
|
62957
62470
|
* @param {*} [options] Override http request option.
|
|
62958
62471
|
* @throws {RequiredError}
|
|
62472
|
+
* @memberof SearchApi
|
|
62959
62473
|
*/
|
|
62960
|
-
v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios
|
|
62474
|
+
v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaBasedDefaultsResponseWrapper, any, {}>>;
|
|
62961
62475
|
/**
|
|
62962
62476
|
* 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
62477
|
* @summary Search (GET)
|
|
@@ -63006,8 +62520,9 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
|
63006
62520
|
* @param {string} [facetSearchText] Text to filter facet values
|
|
63007
62521
|
* @param {*} [options] Override http request option.
|
|
63008
62522
|
* @throws {RequiredError}
|
|
62523
|
+
* @memberof SearchApi
|
|
63009
62524
|
*/
|
|
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
|
|
62525
|
+
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, {}>>;
|
|
63011
62526
|
/**
|
|
63012
62527
|
* 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
62528
|
* @summary Search (POST)
|
|
@@ -63019,355 +62534,104 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
|
63019
62534
|
* @param {string} [xSessionId] Session ID for personalization
|
|
63020
62535
|
* @param {*} [options] Override http request option.
|
|
63021
62536
|
* @throws {RequiredError}
|
|
62537
|
+
* @memberof SearchApi
|
|
63022
62538
|
*/
|
|
63023
|
-
v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios
|
|
63024
|
-
}
|
|
62539
|
+
v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOfficialSearchResponseWrapper, any, {}>>;
|
|
62540
|
+
}
|
|
63025
62541
|
/**
|
|
63026
|
-
*
|
|
62542
|
+
* StopwordsApi - axios parameter creator
|
|
63027
62543
|
* @export
|
|
63028
62544
|
*/
|
|
63029
|
-
export declare const
|
|
62545
|
+
export declare const StopwordsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
63030
62546
|
/**
|
|
63031
|
-
*
|
|
63032
|
-
* @summary
|
|
63033
|
-
* @param {string}
|
|
63034
|
-
* @param {
|
|
62547
|
+
* Fetches available languages/locales with pagination
|
|
62548
|
+
* @summary Get available languages
|
|
62549
|
+
* @param {string} [type] Type filter (stopwords, synonyms)
|
|
62550
|
+
* @param {number} [page] Page number (default: 1)
|
|
62551
|
+
* @param {number} [limit] Items per page (default: 10)
|
|
63035
62552
|
* @param {*} [options] Override http request option.
|
|
63036
62553
|
* @throws {RequiredError}
|
|
63037
62554
|
*/
|
|
63038
|
-
|
|
62555
|
+
adminStoresStopwordsLanguagesGet: (type?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63039
62556
|
/**
|
|
63040
|
-
*
|
|
63041
|
-
* @summary
|
|
63042
|
-
* @param {string}
|
|
62557
|
+
* Enables or disables a specific word for a store. Supports default words, store-specific words, and custom words.
|
|
62558
|
+
* @summary Update word status for store
|
|
62559
|
+
* @param {string} xStoreID X-Store ID
|
|
62560
|
+
* @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.
|
|
63043
62561
|
* @param {*} [options] Override http request option.
|
|
63044
62562
|
* @throws {RequiredError}
|
|
63045
62563
|
*/
|
|
63046
|
-
|
|
62564
|
+
adminStoresXStoreIDStopwordsWordStatusPut: (xStoreID: string, dataTypesUpdateWordStatusRequest: DataTypesUpdateWordStatusRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63047
62565
|
/**
|
|
63048
|
-
*
|
|
63049
|
-
* @summary Get
|
|
63050
|
-
* @param {string}
|
|
62566
|
+
* Fetches a single word list by language with pagination on words within the wordlist
|
|
62567
|
+
* @summary Get word lists by language
|
|
62568
|
+
* @param {string} xStoreID X-Store ID
|
|
62569
|
+
* @param {string} [lang] Language locale filter (e.g. \'en\', \'ar\')
|
|
62570
|
+
* @param {string} [type] Type filter (stopwords, synonyms)
|
|
62571
|
+
* @param {number} [page] Page number (default: 1)
|
|
62572
|
+
* @param {number} [limit] Items per page (default: 10)
|
|
63051
62573
|
* @param {*} [options] Override http request option.
|
|
63052
62574
|
* @throws {RequiredError}
|
|
63053
62575
|
*/
|
|
63054
|
-
|
|
62576
|
+
adminStoresXStoreIDStopwordsWordlistsGet: (xStoreID: string, lang?: string, type?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63055
62577
|
/**
|
|
63056
|
-
*
|
|
63057
|
-
* @summary
|
|
63058
|
-
* @param {string}
|
|
63059
|
-
* @param {
|
|
62578
|
+
* 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.
|
|
62579
|
+
* @summary Get word lists by language (includes store-specific words)
|
|
62580
|
+
* @param {string} xStoreID X-Store ID
|
|
62581
|
+
* @param {string} [lang] Language locale filter (e.g. \'en\', \'ar\')
|
|
62582
|
+
* @param {string} [type] Type filter (stopwords, synonyms)
|
|
62583
|
+
* @param {string} [q] Search query to filter words (case-insensitive)
|
|
62584
|
+
* @param {number} [page] Page number (default: 1)
|
|
62585
|
+
* @param {number} [limit] Items per page (default: 10)
|
|
63060
62586
|
* @param {*} [options] Override http request option.
|
|
63061
62587
|
* @throws {RequiredError}
|
|
63062
62588
|
*/
|
|
63063
|
-
|
|
62589
|
+
adminStoresXStoreIDStopwordsWordlistsWithStoreWordsGet: (xStoreID: string, lang?: string, type?: string, q?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63064
62590
|
/**
|
|
63065
|
-
*
|
|
63066
|
-
* @summary
|
|
63067
|
-
* @param {string}
|
|
63068
|
-
* @param {
|
|
63069
|
-
* @param {
|
|
62591
|
+
* 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)\" ]` ---
|
|
62592
|
+
* @summary Remove words from language word list
|
|
62593
|
+
* @param {string} xStoreID X-Store ID
|
|
62594
|
+
* @param {number} wordListID Word List ID
|
|
62595
|
+
* @param {DataTypesRemoveWordsFromLanguageListRequest} dataTypesRemoveWordsFromLanguageListRequest Remove words request
|
|
63070
62596
|
* @param {*} [options] Override http request option.
|
|
63071
62597
|
* @throws {RequiredError}
|
|
63072
62598
|
*/
|
|
63073
|
-
|
|
62599
|
+
adminStoresXStoreIDStopwordsWordlistsWordListIDWordsDelete: (xStoreID: string, wordListID: number, dataTypesRemoveWordsFromLanguageListRequest: DataTypesRemoveWordsFromLanguageListRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63074
62600
|
/**
|
|
63075
|
-
*
|
|
63076
|
-
* @summary
|
|
63077
|
-
* @param {string}
|
|
62601
|
+
* 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.
|
|
62602
|
+
* @summary Add words to language word list
|
|
62603
|
+
* @param {string} xStoreID X-Store ID
|
|
62604
|
+
* @param {number} wordListID Word List ID
|
|
62605
|
+
* @param {DataTypesAddWordsToLanguageListRequest} dataTypesAddWordsToLanguageListRequest Add words request
|
|
63078
62606
|
* @param {*} [options] Override http request option.
|
|
63079
62607
|
* @throws {RequiredError}
|
|
63080
62608
|
*/
|
|
63081
|
-
|
|
62609
|
+
adminStoresXStoreIDStopwordsWordlistsWordListIDWordsPost: (xStoreID: string, wordListID: number, dataTypesAddWordsToLanguageListRequest: DataTypesAddWordsToLanguageListRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
62610
|
+
};
|
|
62611
|
+
/**
|
|
62612
|
+
* StopwordsApi - functional programming interface
|
|
62613
|
+
* @export
|
|
62614
|
+
*/
|
|
62615
|
+
export declare const StopwordsApiFp: (configuration?: Configuration) => {
|
|
63082
62616
|
/**
|
|
63083
|
-
*
|
|
63084
|
-
* @summary
|
|
63085
|
-
* @param {string}
|
|
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
|
|
62617
|
+
* Fetches available languages/locales with pagination
|
|
62618
|
+
* @summary Get available languages
|
|
62619
|
+
* @param {string} [type] Type filter (stopwords, synonyms)
|
|
63091
62620
|
* @param {number} [page] Page number (default: 1)
|
|
63092
|
-
* @param {number} [
|
|
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
|
|
62621
|
+
* @param {number} [limit] Items per page (default: 10)
|
|
63128
62622
|
* @param {*} [options] Override http request option.
|
|
63129
62623
|
* @throws {RequiredError}
|
|
63130
62624
|
*/
|
|
63131
|
-
|
|
62625
|
+
adminStoresStopwordsLanguagesGet(type?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesLanguagesResponseWrapper>>;
|
|
63132
62626
|
/**
|
|
63133
|
-
*
|
|
63134
|
-
* @summary
|
|
63135
|
-
* @param {string}
|
|
63136
|
-
* @param {
|
|
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
|
|
62627
|
+
* Enables or disables a specific word for a store. Supports default words, store-specific words, and custom words.
|
|
62628
|
+
* @summary Update word status for store
|
|
62629
|
+
* @param {string} xStoreID X-Store ID
|
|
62630
|
+
* @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.
|
|
63141
62631
|
* @param {*} [options] Override http request option.
|
|
63142
62632
|
* @throws {RequiredError}
|
|
63143
62633
|
*/
|
|
63144
|
-
|
|
63145
|
-
};
|
|
63146
|
-
/**
|
|
63147
|
-
* SearchApi - object-oriented interface
|
|
63148
|
-
* @export
|
|
63149
|
-
* @class SearchApi
|
|
63150
|
-
* @extends {BaseAPI}
|
|
63151
|
-
*/
|
|
63152
|
-
export declare class SearchApi extends BaseAPI {
|
|
63153
|
-
/**
|
|
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
|
|
63158
|
-
* @param {*} [options] Override http request option.
|
|
63159
|
-
* @throws {RequiredError}
|
|
63160
|
-
* @memberof SearchApi
|
|
63161
|
-
*/
|
|
63162
|
-
adminV1SearchXStoreIDPost(xStoreID: string, dataTypesAdminSearchRequest: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesCombinedSearchResponseWrapper, any, {}>>;
|
|
63163
|
-
/**
|
|
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
|
|
63167
|
-
* @param {*} [options] Override http request option.
|
|
63168
|
-
* @throws {RequiredError}
|
|
63169
|
-
* @memberof SearchApi
|
|
63170
|
-
*/
|
|
63171
|
-
v1IndexConfigSchemaGet(indexname?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesConfigurationSchemaResponseWrapper, any, {}>>;
|
|
63172
|
-
/**
|
|
63173
|
-
* Get the current index configuration
|
|
63174
|
-
* @summary Get Index Config
|
|
63175
|
-
* @param {string} indexname Index Name
|
|
63176
|
-
* @param {*} [options] Override http request option.
|
|
63177
|
-
* @throws {RequiredError}
|
|
63178
|
-
* @memberof SearchApi
|
|
63179
|
-
*/
|
|
63180
|
-
v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesIndexConfigResponseWrapper, any, {}>>;
|
|
63181
|
-
/**
|
|
63182
|
-
* Configure the index for search
|
|
63183
|
-
* @summary Index Config
|
|
63184
|
-
* @param {string} indexname Index Name
|
|
63185
|
-
* @param {DataTypesIndexConfig} dataTypesIndexConfig Index configuration
|
|
63186
|
-
* @param {*} [options] Override http request option.
|
|
63187
|
-
* @throws {RequiredError}
|
|
63188
|
-
* @memberof SearchApi
|
|
63189
|
-
*/
|
|
63190
|
-
v1IndexIndexnameConfigPost(indexname: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
63191
|
-
/**
|
|
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
|
|
63197
|
-
* @param {*} [options] Override http request option.
|
|
63198
|
-
* @throws {RequiredError}
|
|
63199
|
-
* @memberof SearchApi
|
|
63200
|
-
*/
|
|
63201
|
-
v1IndexIndexnameConfigPropertyPatch(indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
63202
|
-
/**
|
|
63203
|
-
* Get default configuration values computed from the Typesense schema
|
|
63204
|
-
* @summary Get Schema-Based Defaults
|
|
63205
|
-
* @param {string} indexname Index Name
|
|
63206
|
-
* @param {*} [options] Override http request option.
|
|
63207
|
-
* @throws {RequiredError}
|
|
63208
|
-
* @memberof SearchApi
|
|
63209
|
-
*/
|
|
63210
|
-
v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaBasedDefaultsResponseWrapper, any, {}>>;
|
|
63211
|
-
/**
|
|
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
|
|
63257
|
-
* @param {*} [options] Override http request option.
|
|
63258
|
-
* @throws {RequiredError}
|
|
63259
|
-
* @memberof SearchApi
|
|
63260
|
-
*/
|
|
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, {}>>;
|
|
63262
|
-
/**
|
|
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
|
|
63271
|
-
* @param {*} [options] Override http request option.
|
|
63272
|
-
* @throws {RequiredError}
|
|
63273
|
-
* @memberof SearchApi
|
|
63274
|
-
*/
|
|
63275
|
-
v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOfficialSearchResponseWrapper, any, {}>>;
|
|
63276
|
-
}
|
|
63277
|
-
/**
|
|
63278
|
-
* StopwordsApi - axios parameter creator
|
|
63279
|
-
* @export
|
|
63280
|
-
*/
|
|
63281
|
-
export declare const StopwordsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
63282
|
-
/**
|
|
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)
|
|
63288
|
-
* @param {*} [options] Override http request option.
|
|
63289
|
-
* @throws {RequiredError}
|
|
63290
|
-
*/
|
|
63291
|
-
adminStoresStopwordsLanguagesGet: (type?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63292
|
-
/**
|
|
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.
|
|
63297
|
-
* @param {*} [options] Override http request option.
|
|
63298
|
-
* @throws {RequiredError}
|
|
63299
|
-
*/
|
|
63300
|
-
adminStoresXStoreIDStopwordsWordStatusPut: (xStoreID: string, dataTypesUpdateWordStatusRequest: DataTypesUpdateWordStatusRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63301
|
-
/**
|
|
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. \'en\', \'ar\')
|
|
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)
|
|
63309
|
-
* @param {*} [options] Override http request option.
|
|
63310
|
-
* @throws {RequiredError}
|
|
63311
|
-
*/
|
|
63312
|
-
adminStoresXStoreIDStopwordsWordlistsGet: (xStoreID: string, lang?: string, type?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63313
|
-
/**
|
|
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. \'en\', \'ar\')
|
|
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)
|
|
63322
|
-
* @param {*} [options] Override http request option.
|
|
63323
|
-
* @throws {RequiredError}
|
|
63324
|
-
*/
|
|
63325
|
-
adminStoresXStoreIDStopwordsWordlistsWithStoreWordsGet: (xStoreID: string, lang?: string, type?: string, q?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63326
|
-
/**
|
|
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
|
|
63332
|
-
* @param {*} [options] Override http request option.
|
|
63333
|
-
* @throws {RequiredError}
|
|
63334
|
-
*/
|
|
63335
|
-
adminStoresXStoreIDStopwordsWordlistsWordListIDWordsDelete: (xStoreID: string, wordListID: number, dataTypesRemoveWordsFromLanguageListRequest: DataTypesRemoveWordsFromLanguageListRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63336
|
-
/**
|
|
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
|
|
63342
|
-
* @param {*} [options] Override http request option.
|
|
63343
|
-
* @throws {RequiredError}
|
|
63344
|
-
*/
|
|
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) => {
|
|
63352
|
-
/**
|
|
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)
|
|
63358
|
-
* @param {*} [options] Override http request option.
|
|
63359
|
-
* @throws {RequiredError}
|
|
63360
|
-
*/
|
|
63361
|
-
adminStoresStopwordsLanguagesGet(type?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesLanguagesResponseWrapper>>;
|
|
63362
|
-
/**
|
|
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.
|
|
63367
|
-
* @param {*} [options] Override http request option.
|
|
63368
|
-
* @throws {RequiredError}
|
|
63369
|
-
*/
|
|
63370
|
-
adminStoresXStoreIDStopwordsWordStatusPut(xStoreID: string, dataTypesUpdateWordStatusRequest: DataTypesUpdateWordStatusRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesUpdateWordStatusResponseWrapper>>;
|
|
62634
|
+
adminStoresXStoreIDStopwordsWordStatusPut(xStoreID: string, dataTypesUpdateWordStatusRequest: DataTypesUpdateWordStatusRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesUpdateWordStatusResponseWrapper>>;
|
|
63371
62635
|
/**
|
|
63372
62636
|
* Fetches a single word list by language with pagination on words within the wordlist
|
|
63373
62637
|
* @summary Get word lists by language
|
|
@@ -64260,6 +63524,630 @@ export declare class StoreDocumentsApi extends BaseAPI {
|
|
|
64260
63524
|
*/
|
|
64261
63525
|
adminStoresXStoreIDDocumentsPost(xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
|
|
64262
63526
|
}
|
|
63527
|
+
/**
|
|
63528
|
+
* StoreManagementApi - axios parameter creator
|
|
63529
|
+
* @export
|
|
63530
|
+
*/
|
|
63531
|
+
export declare const StoreManagementApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
63532
|
+
/**
|
|
63533
|
+
* 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.
|
|
63534
|
+
* @summary Create Store (Public SDK API)
|
|
63535
|
+
* @param {string} authorization Bearer JWT Token
|
|
63536
|
+
* @param {DataTypesPublicCreateStoreRequest} dataTypesPublicCreateStoreRequest Store creation request
|
|
63537
|
+
* @param {*} [options] Override http request option.
|
|
63538
|
+
* @throws {RequiredError}
|
|
63539
|
+
*/
|
|
63540
|
+
apiV1StoresPost: (authorization: string, dataTypesPublicCreateStoreRequest: DataTypesPublicCreateStoreRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63541
|
+
/**
|
|
63542
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
63543
|
+
* @summary Get store configuration
|
|
63544
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63545
|
+
* @param {string} xStoresecret Store read secret
|
|
63546
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63547
|
+
* @param {*} [options] Override http request option.
|
|
63548
|
+
* @throws {RequiredError}
|
|
63549
|
+
*/
|
|
63550
|
+
apiV1StoresXStoreIDConfigGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63551
|
+
/**
|
|
63552
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
63553
|
+
* @summary Update store configuration
|
|
63554
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63555
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
63556
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63557
|
+
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
63558
|
+
* @param {*} [options] Override http request option.
|
|
63559
|
+
* @throws {RequiredError}
|
|
63560
|
+
*/
|
|
63561
|
+
apiV1StoresXStoreIDConfigPut: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63562
|
+
/**
|
|
63563
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
63564
|
+
* @summary Get store config schema
|
|
63565
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63566
|
+
* @param {string} xStoresecret Store read secret
|
|
63567
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63568
|
+
* @param {*} [options] Override http request option.
|
|
63569
|
+
* @throws {RequiredError}
|
|
63570
|
+
*/
|
|
63571
|
+
apiV1StoresXStoreIDConfigSchemaGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63572
|
+
/**
|
|
63573
|
+
* 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.
|
|
63574
|
+
* @summary Bulk index documents
|
|
63575
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63576
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
63577
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63578
|
+
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
63579
|
+
* @param {*} [options] Override http request option.
|
|
63580
|
+
* @throws {RequiredError}
|
|
63581
|
+
*/
|
|
63582
|
+
apiV1StoresXStoreIDDocumentsBulkPost: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63583
|
+
/**
|
|
63584
|
+
* 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.
|
|
63585
|
+
* @summary Clear all documents
|
|
63586
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63587
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
63588
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63589
|
+
* @param {*} [options] Override http request option.
|
|
63590
|
+
* @throws {RequiredError}
|
|
63591
|
+
*/
|
|
63592
|
+
apiV1StoresXStoreIDDocumentsDelete: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63593
|
+
/**
|
|
63594
|
+
* 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.
|
|
63595
|
+
* @summary Delete a document
|
|
63596
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63597
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
63598
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63599
|
+
* @param {string} documentID Document ID to delete
|
|
63600
|
+
* @param {*} [options] Override http request option.
|
|
63601
|
+
* @throws {RequiredError}
|
|
63602
|
+
*/
|
|
63603
|
+
apiV1StoresXStoreIDDocumentsDocumentIDDelete: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63604
|
+
/**
|
|
63605
|
+
* 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.
|
|
63606
|
+
* @summary Get a document by ID
|
|
63607
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63608
|
+
* @param {string} xStoresecret Store read secret
|
|
63609
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63610
|
+
* @param {string} documentID Document ID to retrieve
|
|
63611
|
+
* @param {*} [options] Override http request option.
|
|
63612
|
+
* @throws {RequiredError}
|
|
63613
|
+
*/
|
|
63614
|
+
apiV1StoresXStoreIDDocumentsDocumentIDGet: (xStoreid: string, xStoresecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63615
|
+
/**
|
|
63616
|
+
* 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.
|
|
63617
|
+
* @summary Index a single document
|
|
63618
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63619
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
63620
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63621
|
+
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
63622
|
+
* @param {*} [options] Override http request option.
|
|
63623
|
+
* @throws {RequiredError}
|
|
63624
|
+
*/
|
|
63625
|
+
apiV1StoresXStoreIDDocumentsPost: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63626
|
+
/**
|
|
63627
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
63628
|
+
* @summary Get store info
|
|
63629
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63630
|
+
* @param {string} xStoresecret Store read secret
|
|
63631
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63632
|
+
* @param {*} [options] Override http request option.
|
|
63633
|
+
* @throws {RequiredError}
|
|
63634
|
+
*/
|
|
63635
|
+
apiV1StoresXStoreIDGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63636
|
+
/**
|
|
63637
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
63638
|
+
* @summary Get query suggestions configuration
|
|
63639
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63640
|
+
* @param {string} xStoresecret Store read secret
|
|
63641
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63642
|
+
* @param {*} [options] Override http request option.
|
|
63643
|
+
* @throws {RequiredError}
|
|
63644
|
+
*/
|
|
63645
|
+
apiV1StoresXStoreIDQuerySuggestionsConfigGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63646
|
+
/**
|
|
63647
|
+
* 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.
|
|
63648
|
+
* @summary Update query suggestions configuration
|
|
63649
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63650
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
63651
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63652
|
+
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
63653
|
+
* @param {*} [options] Override http request option.
|
|
63654
|
+
* @throws {RequiredError}
|
|
63655
|
+
*/
|
|
63656
|
+
apiV1StoresXStoreIDQuerySuggestionsConfigPut: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63657
|
+
/**
|
|
63658
|
+
* 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.
|
|
63659
|
+
* @summary Get index schema
|
|
63660
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63661
|
+
* @param {string} xStoresecret Store read secret
|
|
63662
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63663
|
+
* @param {*} [options] Override http request option.
|
|
63664
|
+
* @throws {RequiredError}
|
|
63665
|
+
*/
|
|
63666
|
+
apiV1StoresXStoreIDSchemaGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63667
|
+
/**
|
|
63668
|
+
* 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.
|
|
63669
|
+
* @summary Create or update index schema
|
|
63670
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63671
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
63672
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63673
|
+
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
63674
|
+
* @param {*} [options] Override http request option.
|
|
63675
|
+
* @throws {RequiredError}
|
|
63676
|
+
*/
|
|
63677
|
+
apiV1StoresXStoreIDSchemaPost: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63678
|
+
};
|
|
63679
|
+
/**
|
|
63680
|
+
* StoreManagementApi - functional programming interface
|
|
63681
|
+
* @export
|
|
63682
|
+
*/
|
|
63683
|
+
export declare const StoreManagementApiFp: (configuration?: Configuration) => {
|
|
63684
|
+
/**
|
|
63685
|
+
* 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.
|
|
63686
|
+
* @summary Create Store (Public SDK API)
|
|
63687
|
+
* @param {string} authorization Bearer JWT Token
|
|
63688
|
+
* @param {DataTypesPublicCreateStoreRequest} dataTypesPublicCreateStoreRequest Store creation request
|
|
63689
|
+
* @param {*} [options] Override http request option.
|
|
63690
|
+
* @throws {RequiredError}
|
|
63691
|
+
*/
|
|
63692
|
+
apiV1StoresPost(authorization: string, dataTypesPublicCreateStoreRequest: DataTypesPublicCreateStoreRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesPublicCreateStoreResponse>>;
|
|
63693
|
+
/**
|
|
63694
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
63695
|
+
* @summary Get store configuration
|
|
63696
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63697
|
+
* @param {string} xStoresecret Store read secret
|
|
63698
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63699
|
+
* @param {*} [options] Override http request option.
|
|
63700
|
+
* @throws {RequiredError}
|
|
63701
|
+
*/
|
|
63702
|
+
apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse>>;
|
|
63703
|
+
/**
|
|
63704
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
63705
|
+
* @summary Update store configuration
|
|
63706
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63707
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
63708
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63709
|
+
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
63710
|
+
* @param {*} [options] Override http request option.
|
|
63711
|
+
* @throws {RequiredError}
|
|
63712
|
+
*/
|
|
63713
|
+
apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponseWrapper>>;
|
|
63714
|
+
/**
|
|
63715
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
63716
|
+
* @summary Get store config schema
|
|
63717
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63718
|
+
* @param {string} xStoresecret Store read secret
|
|
63719
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63720
|
+
* @param {*} [options] Override http request option.
|
|
63721
|
+
* @throws {RequiredError}
|
|
63722
|
+
*/
|
|
63723
|
+
apiV1StoresXStoreIDConfigSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>>;
|
|
63724
|
+
/**
|
|
63725
|
+
* 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.
|
|
63726
|
+
* @summary Bulk index documents
|
|
63727
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63728
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
63729
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63730
|
+
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
63731
|
+
* @param {*} [options] Override http request option.
|
|
63732
|
+
* @throws {RequiredError}
|
|
63733
|
+
*/
|
|
63734
|
+
apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesBulkDocumentResponseWrapper>>;
|
|
63735
|
+
/**
|
|
63736
|
+
* 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.
|
|
63737
|
+
* @summary Clear all documents
|
|
63738
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63739
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
63740
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63741
|
+
* @param {*} [options] Override http request option.
|
|
63742
|
+
* @throws {RequiredError}
|
|
63743
|
+
*/
|
|
63744
|
+
apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesClearDocumentsResponseWrapper>>;
|
|
63745
|
+
/**
|
|
63746
|
+
* 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.
|
|
63747
|
+
* @summary Delete a document
|
|
63748
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63749
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
63750
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63751
|
+
* @param {string} documentID Document ID to delete
|
|
63752
|
+
* @param {*} [options] Override http request option.
|
|
63753
|
+
* @throws {RequiredError}
|
|
63754
|
+
*/
|
|
63755
|
+
apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
|
|
63756
|
+
/**
|
|
63757
|
+
* 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.
|
|
63758
|
+
* @summary Get a document by ID
|
|
63759
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63760
|
+
* @param {string} xStoresecret Store read secret
|
|
63761
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63762
|
+
* @param {string} documentID Document ID to retrieve
|
|
63763
|
+
* @param {*} [options] Override http request option.
|
|
63764
|
+
* @throws {RequiredError}
|
|
63765
|
+
*/
|
|
63766
|
+
apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
|
|
63767
|
+
/**
|
|
63768
|
+
* 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.
|
|
63769
|
+
* @summary Index a single document
|
|
63770
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63771
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
63772
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63773
|
+
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
63774
|
+
* @param {*} [options] Override http request option.
|
|
63775
|
+
* @throws {RequiredError}
|
|
63776
|
+
*/
|
|
63777
|
+
apiV1StoresXStoreIDDocumentsPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
|
|
63778
|
+
/**
|
|
63779
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
63780
|
+
* @summary Get store info
|
|
63781
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63782
|
+
* @param {string} xStoresecret Store read secret
|
|
63783
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63784
|
+
* @param {*} [options] Override http request option.
|
|
63785
|
+
* @throws {RequiredError}
|
|
63786
|
+
*/
|
|
63787
|
+
apiV1StoresXStoreIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesPublicStoreInfoResponse>>;
|
|
63788
|
+
/**
|
|
63789
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
63790
|
+
* @summary Get query suggestions configuration
|
|
63791
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63792
|
+
* @param {string} xStoresecret Store read secret
|
|
63793
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63794
|
+
* @param {*} [options] Override http request option.
|
|
63795
|
+
* @throws {RequiredError}
|
|
63796
|
+
*/
|
|
63797
|
+
apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>>;
|
|
63798
|
+
/**
|
|
63799
|
+
* 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.
|
|
63800
|
+
* @summary Update query suggestions configuration
|
|
63801
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63802
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
63803
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63804
|
+
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
63805
|
+
* @param {*} [options] Override http request option.
|
|
63806
|
+
* @throws {RequiredError}
|
|
63807
|
+
*/
|
|
63808
|
+
apiV1StoresXStoreIDQuerySuggestionsConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>>;
|
|
63809
|
+
/**
|
|
63810
|
+
* 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.
|
|
63811
|
+
* @summary Get index schema
|
|
63812
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63813
|
+
* @param {string} xStoresecret Store read secret
|
|
63814
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63815
|
+
* @param {*} [options] Override http request option.
|
|
63816
|
+
* @throws {RequiredError}
|
|
63817
|
+
*/
|
|
63818
|
+
apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaResponseWrapper>>;
|
|
63819
|
+
/**
|
|
63820
|
+
* 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.
|
|
63821
|
+
* @summary Create or update index schema
|
|
63822
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63823
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
63824
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63825
|
+
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
63826
|
+
* @param {*} [options] Override http request option.
|
|
63827
|
+
* @throws {RequiredError}
|
|
63828
|
+
*/
|
|
63829
|
+
apiV1StoresXStoreIDSchemaPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaResponseWrapper>>;
|
|
63830
|
+
};
|
|
63831
|
+
/**
|
|
63832
|
+
* StoreManagementApi - factory interface
|
|
63833
|
+
* @export
|
|
63834
|
+
*/
|
|
63835
|
+
export declare const StoreManagementApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
63836
|
+
/**
|
|
63837
|
+
* 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.
|
|
63838
|
+
* @summary Create Store (Public SDK API)
|
|
63839
|
+
* @param {string} authorization Bearer JWT Token
|
|
63840
|
+
* @param {DataTypesPublicCreateStoreRequest} dataTypesPublicCreateStoreRequest Store creation request
|
|
63841
|
+
* @param {*} [options] Override http request option.
|
|
63842
|
+
* @throws {RequiredError}
|
|
63843
|
+
*/
|
|
63844
|
+
apiV1StoresPost(authorization: string, dataTypesPublicCreateStoreRequest: DataTypesPublicCreateStoreRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesPublicCreateStoreResponse>;
|
|
63845
|
+
/**
|
|
63846
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
63847
|
+
* @summary Get store configuration
|
|
63848
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63849
|
+
* @param {string} xStoresecret Store read secret
|
|
63850
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63851
|
+
* @param {*} [options] Override http request option.
|
|
63852
|
+
* @throws {RequiredError}
|
|
63853
|
+
*/
|
|
63854
|
+
apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse>;
|
|
63855
|
+
/**
|
|
63856
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
63857
|
+
* @summary Update store configuration
|
|
63858
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63859
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
63860
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63861
|
+
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
63862
|
+
* @param {*} [options] Override http request option.
|
|
63863
|
+
* @throws {RequiredError}
|
|
63864
|
+
*/
|
|
63865
|
+
apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponseWrapper>;
|
|
63866
|
+
/**
|
|
63867
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
63868
|
+
* @summary Get store config schema
|
|
63869
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63870
|
+
* @param {string} xStoresecret Store read secret
|
|
63871
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63872
|
+
* @param {*} [options] Override http request option.
|
|
63873
|
+
* @throws {RequiredError}
|
|
63874
|
+
*/
|
|
63875
|
+
apiV1StoresXStoreIDConfigSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>;
|
|
63876
|
+
/**
|
|
63877
|
+
* 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.
|
|
63878
|
+
* @summary Bulk index documents
|
|
63879
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63880
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
63881
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63882
|
+
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
63883
|
+
* @param {*} [options] Override http request option.
|
|
63884
|
+
* @throws {RequiredError}
|
|
63885
|
+
*/
|
|
63886
|
+
apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesBulkDocumentResponseWrapper>;
|
|
63887
|
+
/**
|
|
63888
|
+
* 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.
|
|
63889
|
+
* @summary Clear all documents
|
|
63890
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63891
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
63892
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63893
|
+
* @param {*} [options] Override http request option.
|
|
63894
|
+
* @throws {RequiredError}
|
|
63895
|
+
*/
|
|
63896
|
+
apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesClearDocumentsResponseWrapper>;
|
|
63897
|
+
/**
|
|
63898
|
+
* 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.
|
|
63899
|
+
* @summary Delete a document
|
|
63900
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63901
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
63902
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63903
|
+
* @param {string} documentID Document ID to delete
|
|
63904
|
+
* @param {*} [options] Override http request option.
|
|
63905
|
+
* @throws {RequiredError}
|
|
63906
|
+
*/
|
|
63907
|
+
apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
|
|
63908
|
+
/**
|
|
63909
|
+
* 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.
|
|
63910
|
+
* @summary Get a document by ID
|
|
63911
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63912
|
+
* @param {string} xStoresecret Store read secret
|
|
63913
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63914
|
+
* @param {string} documentID Document ID to retrieve
|
|
63915
|
+
* @param {*} [options] Override http request option.
|
|
63916
|
+
* @throws {RequiredError}
|
|
63917
|
+
*/
|
|
63918
|
+
apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
|
|
63919
|
+
/**
|
|
63920
|
+
* 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.
|
|
63921
|
+
* @summary Index a single document
|
|
63922
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63923
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
63924
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63925
|
+
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
63926
|
+
* @param {*} [options] Override http request option.
|
|
63927
|
+
* @throws {RequiredError}
|
|
63928
|
+
*/
|
|
63929
|
+
apiV1StoresXStoreIDDocumentsPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
|
|
63930
|
+
/**
|
|
63931
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
63932
|
+
* @summary Get store info
|
|
63933
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63934
|
+
* @param {string} xStoresecret Store read secret
|
|
63935
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63936
|
+
* @param {*} [options] Override http request option.
|
|
63937
|
+
* @throws {RequiredError}
|
|
63938
|
+
*/
|
|
63939
|
+
apiV1StoresXStoreIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesPublicStoreInfoResponse>;
|
|
63940
|
+
/**
|
|
63941
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
63942
|
+
* @summary Get query suggestions configuration
|
|
63943
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63944
|
+
* @param {string} xStoresecret Store read secret
|
|
63945
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63946
|
+
* @param {*} [options] Override http request option.
|
|
63947
|
+
* @throws {RequiredError}
|
|
63948
|
+
*/
|
|
63949
|
+
apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>;
|
|
63950
|
+
/**
|
|
63951
|
+
* 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.
|
|
63952
|
+
* @summary Update query suggestions configuration
|
|
63953
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63954
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
63955
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63956
|
+
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
63957
|
+
* @param {*} [options] Override http request option.
|
|
63958
|
+
* @throws {RequiredError}
|
|
63959
|
+
*/
|
|
63960
|
+
apiV1StoresXStoreIDQuerySuggestionsConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>;
|
|
63961
|
+
/**
|
|
63962
|
+
* 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.
|
|
63963
|
+
* @summary Get index schema
|
|
63964
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63965
|
+
* @param {string} xStoresecret Store read secret
|
|
63966
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63967
|
+
* @param {*} [options] Override http request option.
|
|
63968
|
+
* @throws {RequiredError}
|
|
63969
|
+
*/
|
|
63970
|
+
apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaResponseWrapper>;
|
|
63971
|
+
/**
|
|
63972
|
+
* 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.
|
|
63973
|
+
* @summary Create or update index schema
|
|
63974
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
63975
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
63976
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63977
|
+
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
63978
|
+
* @param {*} [options] Override http request option.
|
|
63979
|
+
* @throws {RequiredError}
|
|
63980
|
+
*/
|
|
63981
|
+
apiV1StoresXStoreIDSchemaPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaResponseWrapper>;
|
|
63982
|
+
};
|
|
63983
|
+
/**
|
|
63984
|
+
* StoreManagementApi - object-oriented interface
|
|
63985
|
+
* @export
|
|
63986
|
+
* @class StoreManagementApi
|
|
63987
|
+
* @extends {BaseAPI}
|
|
63988
|
+
*/
|
|
63989
|
+
export declare class StoreManagementApi extends BaseAPI {
|
|
63990
|
+
/**
|
|
63991
|
+
* 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.
|
|
63992
|
+
* @summary Create Store (Public SDK API)
|
|
63993
|
+
* @param {string} authorization Bearer JWT Token
|
|
63994
|
+
* @param {DataTypesPublicCreateStoreRequest} dataTypesPublicCreateStoreRequest Store creation request
|
|
63995
|
+
* @param {*} [options] Override http request option.
|
|
63996
|
+
* @throws {RequiredError}
|
|
63997
|
+
* @memberof StoreManagementApi
|
|
63998
|
+
*/
|
|
63999
|
+
apiV1StoresPost(authorization: string, dataTypesPublicCreateStoreRequest: DataTypesPublicCreateStoreRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesPublicCreateStoreResponse, any, {}>>;
|
|
64000
|
+
/**
|
|
64001
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
64002
|
+
* @summary Get store configuration
|
|
64003
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
64004
|
+
* @param {string} xStoresecret Store read secret
|
|
64005
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
64006
|
+
* @param {*} [options] Override http request option.
|
|
64007
|
+
* @throws {RequiredError}
|
|
64008
|
+
* @memberof StoreManagementApi
|
|
64009
|
+
*/
|
|
64010
|
+
apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse, any, {}>>;
|
|
64011
|
+
/**
|
|
64012
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
64013
|
+
* @summary Update store configuration
|
|
64014
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
64015
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
64016
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
64017
|
+
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
64018
|
+
* @param {*} [options] Override http request option.
|
|
64019
|
+
* @throws {RequiredError}
|
|
64020
|
+
* @memberof StoreManagementApi
|
|
64021
|
+
*/
|
|
64022
|
+
apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesIndexConfigResponseWrapper, any, {}>>;
|
|
64023
|
+
/**
|
|
64024
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
64025
|
+
* @summary Get store config schema
|
|
64026
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
64027
|
+
* @param {string} xStoresecret Store read secret
|
|
64028
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
64029
|
+
* @param {*} [options] Override http request option.
|
|
64030
|
+
* @throws {RequiredError}
|
|
64031
|
+
* @memberof StoreManagementApi
|
|
64032
|
+
*/
|
|
64033
|
+
apiV1StoresXStoreIDConfigSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesConfigurationSchemaResponseWrapper, any, {}>>;
|
|
64034
|
+
/**
|
|
64035
|
+
* 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.
|
|
64036
|
+
* @summary Bulk index documents
|
|
64037
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
64038
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
64039
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
64040
|
+
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
64041
|
+
* @param {*} [options] Override http request option.
|
|
64042
|
+
* @throws {RequiredError}
|
|
64043
|
+
* @memberof StoreManagementApi
|
|
64044
|
+
*/
|
|
64045
|
+
apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesBulkDocumentResponseWrapper, any, {}>>;
|
|
64046
|
+
/**
|
|
64047
|
+
* 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.
|
|
64048
|
+
* @summary Clear all documents
|
|
64049
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
64050
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
64051
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
64052
|
+
* @param {*} [options] Override http request option.
|
|
64053
|
+
* @throws {RequiredError}
|
|
64054
|
+
* @memberof StoreManagementApi
|
|
64055
|
+
*/
|
|
64056
|
+
apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesClearDocumentsResponseWrapper, any, {}>>;
|
|
64057
|
+
/**
|
|
64058
|
+
* 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.
|
|
64059
|
+
* @summary Delete a document
|
|
64060
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
64061
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
64062
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
64063
|
+
* @param {string} documentID Document ID to delete
|
|
64064
|
+
* @param {*} [options] Override http request option.
|
|
64065
|
+
* @throws {RequiredError}
|
|
64066
|
+
* @memberof StoreManagementApi
|
|
64067
|
+
*/
|
|
64068
|
+
apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
|
|
64069
|
+
/**
|
|
64070
|
+
* 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.
|
|
64071
|
+
* @summary Get a document by ID
|
|
64072
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
64073
|
+
* @param {string} xStoresecret Store read secret
|
|
64074
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
64075
|
+
* @param {string} documentID Document ID to retrieve
|
|
64076
|
+
* @param {*} [options] Override http request option.
|
|
64077
|
+
* @throws {RequiredError}
|
|
64078
|
+
* @memberof StoreManagementApi
|
|
64079
|
+
*/
|
|
64080
|
+
apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
|
|
64081
|
+
/**
|
|
64082
|
+
* 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.
|
|
64083
|
+
* @summary Index a single document
|
|
64084
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
64085
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
64086
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
64087
|
+
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
64088
|
+
* @param {*} [options] Override http request option.
|
|
64089
|
+
* @throws {RequiredError}
|
|
64090
|
+
* @memberof StoreManagementApi
|
|
64091
|
+
*/
|
|
64092
|
+
apiV1StoresXStoreIDDocumentsPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
|
|
64093
|
+
/**
|
|
64094
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
64095
|
+
* @summary Get store info
|
|
64096
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
64097
|
+
* @param {string} xStoresecret Store read secret
|
|
64098
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
64099
|
+
* @param {*} [options] Override http request option.
|
|
64100
|
+
* @throws {RequiredError}
|
|
64101
|
+
* @memberof StoreManagementApi
|
|
64102
|
+
*/
|
|
64103
|
+
apiV1StoresXStoreIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesPublicStoreInfoResponse, any, {}>>;
|
|
64104
|
+
/**
|
|
64105
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
64106
|
+
* @summary Get query suggestions configuration
|
|
64107
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
64108
|
+
* @param {string} xStoresecret Store read secret
|
|
64109
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
64110
|
+
* @param {*} [options] Override http request option.
|
|
64111
|
+
* @throws {RequiredError}
|
|
64112
|
+
* @memberof StoreManagementApi
|
|
64113
|
+
*/
|
|
64114
|
+
apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuerySuggestionsServiceQuerySuggestionsAPIResponse, any, {}>>;
|
|
64115
|
+
/**
|
|
64116
|
+
* 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.
|
|
64117
|
+
* @summary Update query suggestions configuration
|
|
64118
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
64119
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
64120
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
64121
|
+
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
64122
|
+
* @param {*} [options] Override http request option.
|
|
64123
|
+
* @throws {RequiredError}
|
|
64124
|
+
* @memberof StoreManagementApi
|
|
64125
|
+
*/
|
|
64126
|
+
apiV1StoresXStoreIDQuerySuggestionsConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuerySuggestionsServiceQuerySuggestionsAPIResponse, any, {}>>;
|
|
64127
|
+
/**
|
|
64128
|
+
* 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.
|
|
64129
|
+
* @summary Get index schema
|
|
64130
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
64131
|
+
* @param {string} xStoresecret Store read secret
|
|
64132
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
64133
|
+
* @param {*} [options] Override http request option.
|
|
64134
|
+
* @throws {RequiredError}
|
|
64135
|
+
* @memberof StoreManagementApi
|
|
64136
|
+
*/
|
|
64137
|
+
apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaResponseWrapper, any, {}>>;
|
|
64138
|
+
/**
|
|
64139
|
+
* 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.
|
|
64140
|
+
* @summary Create or update index schema
|
|
64141
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
64142
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
64143
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
64144
|
+
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
64145
|
+
* @param {*} [options] Override http request option.
|
|
64146
|
+
* @throws {RequiredError}
|
|
64147
|
+
* @memberof StoreManagementApi
|
|
64148
|
+
*/
|
|
64149
|
+
apiV1StoresXStoreIDSchemaPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaResponseWrapper, any, {}>>;
|
|
64150
|
+
}
|
|
64263
64151
|
/**
|
|
64264
64152
|
* StoresApi - axios parameter creator
|
|
64265
64153
|
* @export
|