@seekora-ai/admin-api 1.0.9 → 1.0.11

package/dist/esm/api.d.ts

@@ -953,6 +953,187 @@ export interface DataTypesGenericStringArrayResponse {
      */
     'status'?: number;
 }
+/**
+ *
+ * @export
+ * @interface DataTypesIndexConfig
+ */
+export interface DataTypesIndexConfig {
+    /**
+     *
+     * @type {boolean}
+     * @memberof DataTypesIndexConfig
+     */
+    'allowTyposOnNumericTokens'?: boolean;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof DataTypesIndexConfig
+     */
+    'alternativesAsExact'?: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof DataTypesIndexConfig
+     */
+    'attributeForDistinct'?: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof DataTypesIndexConfig
+     */
+    'attributesForFaceting'?: Array<string>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof DataTypesIndexConfig
+     */
+    'attributesToHighlight'?: Array<string>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof DataTypesIndexConfig
+     */
+    'attributesToRetrieve'?: Array<string>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof DataTypesIndexConfig
+     */
+    'attributesToSnippet'?: Array<string>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof DataTypesIndexConfig
+     */
+    'customRanking'?: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof DataTypesIndexConfig
+     */
+    'exactOnSingleWordQuery'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof DataTypesIndexConfig
+     */
+    'highlightPostTag'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof DataTypesIndexConfig
+     */
+    'highlightPreTag'?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof DataTypesIndexConfig
+     */
+    'hitsPerPage'?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof DataTypesIndexConfig
+     */
+    'indexingGeolocPrecision'?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof DataTypesIndexConfig
+     */
+    'maxNbHits'?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof DataTypesIndexConfig
+     */
+    'maxValuesPerFacet'?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof DataTypesIndexConfig
+     */
+    'minWordSizefor1Typo'?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof DataTypesIndexConfig
+     */
+    'minWordSizefor2Typos'?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof DataTypesIndexConfig
+     */
+    'nbShardsAuto'?: number;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof DataTypesIndexConfig
+     */
+    'numericAttributesToIndex'?: Array<string>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof DataTypesIndexConfig
+     */
+    'optionalWords'?: Array<string>;
+    /**
+     *
+     * @type {number}
+     * @memberof DataTypesIndexConfig
+     */
+    'paginationLimitedTo'?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof DataTypesIndexConfig
+     */
+    'primary'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof DataTypesIndexConfig
+     */
+    'queryType'?: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof DataTypesIndexConfig
+     */
+    'ranking'?: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof DataTypesIndexConfig
+     */
+    'removeWordsIfNoResults'?: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof DataTypesIndexConfig
+     */
+    'searchableAttributes'?: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof DataTypesIndexConfig
+     */
+    'separatorsToIndex'?: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof DataTypesIndexConfig
+     */
+    'unretrievableAttributes'?: Array<string>;
+    /**
+     *
+     * @type {number}
+     * @memberof DataTypesIndexConfig
+     */
+    'version'?: number;
+}
 /**
  *
  * @export
@@ -1742,7 +1923,7 @@ export interface DataTypesOnboardingRequest {
      * @type {{ [key: string]: any; }}
      * @memberof DataTypesOnboardingRequest
      */
-    'data': {
+    'data'?: {
         [key: string]: any;
     };
     /**
@@ -1751,6 +1932,12 @@ export interface DataTypesOnboardingRequest {
      * @memberof DataTypesOnboardingRequest
      */
     'step': string;
+    /**
+     * Optional visible step
+     * @type {string}
+     * @memberof DataTypesOnboardingRequest
+     */
+    'visibleStep'?: string;
 }
 /**
  *
@@ -1766,16 +1953,24 @@ export interface DataTypesOnboardingResponse {
     'jobId'?: string;
     /**
      *
-     * @type {object}
+     * @type {{ [key: string]: any; }}
      * @memberof DataTypesOnboardingResponse
      */
-    'state'?: object;
+    'state'?: {
+        [key: string]: any;
+    };
     /**
      *
      * @type {string}
      * @memberof DataTypesOnboardingResponse
      */
     'step'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof DataTypesOnboardingResponse
+     */
+    'visibleStep'?: string;
 }
 /**
  *
@@ -2774,6 +2969,62 @@ export interface DataTypesRolesListResponse {
      */
     'status'?: number;
 }
+/**
+ *
+ * @export
+ * @interface DataTypesSampleDatasetResponse
+ */
+export interface DataTypesSampleDatasetResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof DataTypesSampleDatasetResponse
+     */
+    'datasetName'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof DataTypesSampleDatasetResponse
+     */
+    'description'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof DataTypesSampleDatasetResponse
+     */
+    'imageUrl'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof DataTypesSampleDatasetResponse
+     */
+    'storeName'?: string;
+}
+/**
+ *
+ * @export
+ * @interface DataTypesSampleDatasetsResponseWrapper
+ */
+export interface DataTypesSampleDatasetsResponseWrapper {
+    /**
+     *
+     * @type {Array<DataTypesSampleDatasetResponse>}
+     * @memberof DataTypesSampleDatasetsResponseWrapper
+     */
+    'data'?: Array<DataTypesSampleDatasetResponse>;
+    /**
+     *
+     * @type {string}
+     * @memberof DataTypesSampleDatasetsResponseWrapper
+     */
+    'message'?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof DataTypesSampleDatasetsResponseWrapper
+     */
+    'status'?: number;
+}
 /**
  *
  * @export
@@ -6675,7 +6926,7 @@ export declare const OnboardingApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    adminV1UsersSampledatasetsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    adminV1UsersSampledatasetsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSampleDatasetsResponseWrapper>>;
 };
 /**
  * OnboardingApi - factory interface
@@ -6749,7 +7000,7 @@ export declare const OnboardingApiFactory: (configuration?: Configuration, baseP
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    adminV1UsersSampledatasetsGet(options?: RawAxiosRequestConfig): AxiosPromise<object>;
+    adminV1UsersSampledatasetsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSampleDatasetsResponseWrapper>;
 };
 /**
  * OnboardingApi - object-oriented interface
@@ -6834,7 +7085,7 @@ export declare class OnboardingApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof OnboardingApi
      */
-    adminV1UsersSampledatasetsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    adminV1UsersSampledatasetsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSampleDatasetsResponseWrapper, any>>;
 }
 /**
  * OrganizationsApi - axios parameter creator
@@ -8446,6 +8697,212 @@ export declare class RolesApi extends BaseAPI {
      */
     adminRolesPost(role: DataTypesCreateRoleRequestDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any>>;
 }
+/**
+ * SearchApi - axios parameter creator
+ * @export
+ */
+export declare const SearchApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Configure the index for search
+     * @summary Index Config
+     * @param {string} xStoreid Store ID
+     * @param {string} xStoresecret Store Secret
+     * @param {DataTypesIndexConfig} body Index configuration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1IndexConfigPost: (xStoreid: string, xStoresecret: string, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update a single property of the index configuration
+     * @summary Update Index Config Property
+     * @param {string} xStoreid Store ID
+     * @param {string} xStoresecret Store Secret
+     * @param {string} property Property name
+     * @param {object} body Property value
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1IndexConfigPropertyPatch: (xStoreid: string, xStoresecret: string, property: string, body: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Configure the index for search
+     * @summary Index Config
+     * @param {string} xStoreid Store ID
+     * @param {string} xStoresecret Store Secret
+     * @param {string} indexname Index Name
+     * @param {DataTypesIndexConfig} body Index configuration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1IndexIndexnameConfigPost: (xStoreid: string, xStoresecret: string, indexname: string, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update a single property of the index configuration
+     * @summary Update Index Config Property
+     * @param {string} xStoreid Store ID
+     * @param {string} xStoresecret Store Secret
+     * @param {string} indexname Index Name
+     * @param {string} property Property name
+     * @param {object} body Property value
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1IndexIndexnameConfigPropertyPatch: (xStoreid: string, xStoresecret: string, indexname: string, property: string, body: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * SearchApi - functional programming interface
+ * @export
+ */
+export declare const SearchApiFp: (configuration?: Configuration) => {
+    /**
+     * Configure the index for search
+     * @summary Index Config
+     * @param {string} xStoreid Store ID
+     * @param {string} xStoresecret Store Secret
+     * @param {DataTypesIndexConfig} body Index configuration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1IndexConfigPost(xStoreid: string, xStoresecret: string, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
+    /**
+     * Update a single property of the index configuration
+     * @summary Update Index Config Property
+     * @param {string} xStoreid Store ID
+     * @param {string} xStoresecret Store Secret
+     * @param {string} property Property name
+     * @param {object} body Property value
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1IndexConfigPropertyPatch(xStoreid: string, xStoresecret: string, property: string, body: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
+    /**
+     * Configure the index for search
+     * @summary Index Config
+     * @param {string} xStoreid Store ID
+     * @param {string} xStoresecret Store Secret
+     * @param {string} indexname Index Name
+     * @param {DataTypesIndexConfig} body Index configuration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1IndexIndexnameConfigPost(xStoreid: string, xStoresecret: string, indexname: string, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
+    /**
+     * Update a single property of the index configuration
+     * @summary Update Index Config Property
+     * @param {string} xStoreid Store ID
+     * @param {string} xStoresecret Store Secret
+     * @param {string} indexname Index Name
+     * @param {string} property Property name
+     * @param {object} body Property value
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1IndexIndexnameConfigPropertyPatch(xStoreid: string, xStoresecret: string, indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
+};
+/**
+ * SearchApi - factory interface
+ * @export
+ */
+export declare const SearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Configure the index for search
+     * @summary Index Config
+     * @param {string} xStoreid Store ID
+     * @param {string} xStoresecret Store Secret
+     * @param {DataTypesIndexConfig} body Index configuration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1IndexConfigPost(xStoreid: string, xStoresecret: string, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
+    /**
+     * Update a single property of the index configuration
+     * @summary Update Index Config Property
+     * @param {string} xStoreid Store ID
+     * @param {string} xStoresecret Store Secret
+     * @param {string} property Property name
+     * @param {object} body Property value
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1IndexConfigPropertyPatch(xStoreid: string, xStoresecret: string, property: string, body: object, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
+    /**
+     * Configure the index for search
+     * @summary Index Config
+     * @param {string} xStoreid Store ID
+     * @param {string} xStoresecret Store Secret
+     * @param {string} indexname Index Name
+     * @param {DataTypesIndexConfig} body Index configuration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1IndexIndexnameConfigPost(xStoreid: string, xStoresecret: string, indexname: string, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
+    /**
+     * Update a single property of the index configuration
+     * @summary Update Index Config Property
+     * @param {string} xStoreid Store ID
+     * @param {string} xStoresecret Store Secret
+     * @param {string} indexname Index Name
+     * @param {string} property Property name
+     * @param {object} body Property value
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1IndexIndexnameConfigPropertyPatch(xStoreid: string, xStoresecret: string, indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
+};
+/**
+ * SearchApi - object-oriented interface
+ * @export
+ * @class SearchApi
+ * @extends {BaseAPI}
+ */
+export declare class SearchApi extends BaseAPI {
+    /**
+     * Configure the index for search
+     * @summary Index Config
+     * @param {string} xStoreid Store ID
+     * @param {string} xStoresecret Store Secret
+     * @param {DataTypesIndexConfig} body Index configuration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SearchApi
+     */
+    v1IndexConfigPost(xStoreid: string, xStoresecret: string, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any>>;
+    /**
+     * Update a single property of the index configuration
+     * @summary Update Index Config Property
+     * @param {string} xStoreid Store ID
+     * @param {string} xStoresecret Store Secret
+     * @param {string} property Property name
+     * @param {object} body Property value
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SearchApi
+     */
+    v1IndexConfigPropertyPatch(xStoreid: string, xStoresecret: string, property: string, body: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any>>;
+    /**
+     * Configure the index for search
+     * @summary Index Config
+     * @param {string} xStoreid Store ID
+     * @param {string} xStoresecret Store Secret
+     * @param {string} indexname Index Name
+     * @param {DataTypesIndexConfig} body Index configuration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SearchApi
+     */
+    v1IndexIndexnameConfigPost(xStoreid: string, xStoresecret: string, indexname: string, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any>>;
+    /**
+     * Update a single property of the index configuration
+     * @summary Update Index Config Property
+     * @param {string} xStoreid Store ID
+     * @param {string} xStoresecret Store Secret
+     * @param {string} indexname Index Name
+     * @param {string} property Property name
+     * @param {object} body Property value
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SearchApi
+     */
+    v1IndexIndexnameConfigPropertyPatch(xStoreid: string, xStoresecret: string, indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any>>;
+}
 /**
  * StoresApi - axios parameter creator
  * @export