/**
 * Sonatype Lifecycle Public REST API
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: 1.207.0-01
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import * as runtime from '../runtime';
import type { SearchResultDTO } from '../models/index';
export interface AdvancedSearchApiGetExportResultsRequest {
    query: string;
    pageSize?: number;
    page?: number;
    allComponents?: boolean;
    mode?: GetExportResultsModeEnum;
}
export interface AdvancedSearchApiSearchIndexRequest {
    query?: string;
    pageSize?: number;
    page?: number;
    allComponents?: boolean;
    mode?: SearchIndexModeEnum;
}
/**
 * AdvancedSearchApi - interface
 *
 * @export
 * @interface AdvancedSearchApiInterface
 */
export interface AdvancedSearchApiInterface {
    /**
     * Request cancellation of an in-flight Advanced Search index rebuild. On a Lucene-backed deployment the previous complete index continues to serve search results. Cancellation is not supported on OpenSearch-backed deployments, where the rebuild runs to completion. Use the status method to confirm whether a rebuild is still in progress.  Permissions required: Edit System Configuration and Users
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AdvancedSearchApiInterface
     */
    cancelSearchIndexRebuildRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Request cancellation of an in-flight Advanced Search index rebuild. On a Lucene-backed deployment the previous complete index continues to serve search results. Cancellation is not supported on OpenSearch-backed deployments, where the rebuild runs to completion. Use the status method to confirm whether a rebuild is still in progress.  Permissions required: Edit System Configuration and Users
     */
    cancelSearchIndexRebuild(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     * Use this method to create or rebuild the index for Advanced Search. This is a resource intensive operation. Avoid creating indexes during peak usage hours.  Permissions required: Edit System Configuration and Users
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AdvancedSearchApiInterface
     */
    createSearchIndexAsyncRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Use this method to create or rebuild the index for Advanced Search. This is a resource intensive operation. Avoid creating indexes during peak usage hours.  Permissions required: Edit System Configuration and Users
     */
    createSearchIndexAsync(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     * Use this method to generate a csv file containing your search results. The default delimiter in the generated file is comma. Use the advancedSearchCSVExportDelimiter property of the Configuration REST API to change the delimiter in the generated file.
     * @param {string} query A well-formed search query.
     * @param {number} [pageSize] Enter the no. of results that should be visible per page, unset gives all results
     * @param {number} [page] Enter the page no. for the page containing results
     * @param {boolean} [allComponents] Set to &#x60;true&#x60; to retrieve results that include components with no violations.
     * @param {'sbomManager'} [mode]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AdvancedSearchApiInterface
     */
    getExportResultsRaw(requestParameters: AdvancedSearchApiGetExportResultsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Use this method to generate a csv file containing your search results. The default delimiter in the generated file is comma. Use the advancedSearchCSVExportDelimiter property of the Configuration REST API to change the delimiter in the generated file.
     */
    getExportResults(requestParameters: AdvancedSearchApiGetExportResultsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     * Use this method to perform an Advanced Search.
     * @param {string} [query] Enter your search query here
     * @param {number} [pageSize] Enter the no. of results that should be visible per page
     * @param {number} [page] Enter the page no. for the page containing results
     * @param {boolean} [allComponents] Set to &#x60;true&#x60; to retrieve results that include components with no violations
     * @param {'sbomManager'} [mode]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AdvancedSearchApiInterface
     */
    searchIndexRaw(requestParameters: AdvancedSearchApiSearchIndexRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchResultDTO>>;
    /**
     * Use this method to perform an Advanced Search.
     */
    searchIndex(requestParameters: AdvancedSearchApiSearchIndexRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchResultDTO>;
}
/**
 *
 */
export declare class AdvancedSearchApi extends runtime.BaseAPI implements AdvancedSearchApiInterface {
    /**
     * Request cancellation of an in-flight Advanced Search index rebuild. On a Lucene-backed deployment the previous complete index continues to serve search results. Cancellation is not supported on OpenSearch-backed deployments, where the rebuild runs to completion. Use the status method to confirm whether a rebuild is still in progress.  Permissions required: Edit System Configuration and Users
     */
    cancelSearchIndexRebuildRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Request cancellation of an in-flight Advanced Search index rebuild. On a Lucene-backed deployment the previous complete index continues to serve search results. Cancellation is not supported on OpenSearch-backed deployments, where the rebuild runs to completion. Use the status method to confirm whether a rebuild is still in progress.  Permissions required: Edit System Configuration and Users
     */
    cancelSearchIndexRebuild(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     * Use this method to create or rebuild the index for Advanced Search. This is a resource intensive operation. Avoid creating indexes during peak usage hours.  Permissions required: Edit System Configuration and Users
     */
    createSearchIndexAsyncRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Use this method to create or rebuild the index for Advanced Search. This is a resource intensive operation. Avoid creating indexes during peak usage hours.  Permissions required: Edit System Configuration and Users
     */
    createSearchIndexAsync(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     * Use this method to generate a csv file containing your search results. The default delimiter in the generated file is comma. Use the advancedSearchCSVExportDelimiter property of the Configuration REST API to change the delimiter in the generated file.
     */
    getExportResultsRaw(requestParameters: AdvancedSearchApiGetExportResultsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Use this method to generate a csv file containing your search results. The default delimiter in the generated file is comma. Use the advancedSearchCSVExportDelimiter property of the Configuration REST API to change the delimiter in the generated file.
     */
    getExportResults(requestParameters: AdvancedSearchApiGetExportResultsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     * Use this method to perform an Advanced Search.
     */
    searchIndexRaw(requestParameters: AdvancedSearchApiSearchIndexRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchResultDTO>>;
    /**
     * Use this method to perform an Advanced Search.
     */
    searchIndex(requestParameters?: AdvancedSearchApiSearchIndexRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchResultDTO>;
}
/**
 * @export
 */
export declare const GetExportResultsModeEnum: {
    readonly SbomManager: "sbomManager";
};
export type GetExportResultsModeEnum = typeof GetExportResultsModeEnum[keyof typeof GetExportResultsModeEnum];
/**
 * @export
 */
export declare const SearchIndexModeEnum: {
    readonly SbomManager: "sbomManager";
};
export type SearchIndexModeEnum = typeof SearchIndexModeEnum[keyof typeof SearchIndexModeEnum];