/** * Identity Security Cloud API - Saved Search * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import type { RequestArgs } from './base'; import { BaseAPI } from './base'; /** * * @export * @interface Bound */ export interface Bound { /** * The value of the range\'s endpoint. * @type {string} * @memberof Bound */ 'value': string; /** * Indicates if the endpoint is included in the range. * @type {boolean} * @memberof Bound */ 'inclusive'?: boolean; } /** * * @export * @interface Column */ export interface Column { /** * The name of the field. * @type {string} * @memberof Column */ 'field': string; /** * The value of the header. * @type {string} * @memberof Column */ 'header'?: string; } /** * * @export * @interface CreateSavedSearchV1Request */ export interface CreateSavedSearchV1Request { /** * The name of the saved search. * @type {string} * @memberof CreateSavedSearchV1Request */ 'name'?: string; /** * The description of the saved search. * @type {string} * @memberof CreateSavedSearchV1Request */ 'description'?: string | null; /** * A date-time in ISO-8601 format * @type {string} * @memberof CreateSavedSearchV1Request */ 'created'?: string | null; /** * A date-time in ISO-8601 format * @type {string} * @memberof CreateSavedSearchV1Request */ 'modified'?: string | null; /** * The names of the Elasticsearch indices in which to search. * @type {Array} * @memberof CreateSavedSearchV1Request */ 'indices': Array; /** * The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. * @type {{ [key: string]: Array; }} * @memberof CreateSavedSearchV1Request */ 'columns'?: { [key: string]: Array; }; /** * The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. * @type {string} * @memberof CreateSavedSearchV1Request */ 'query': string; /** * The fields to be searched against in a multi-field query. * @type {Array} * @memberof CreateSavedSearchV1Request */ 'fields'?: Array | null; /** * Sort by index. This takes precedence over the `sort` property. * @type {{ [key: string]: Array; }} * @memberof CreateSavedSearchV1Request */ 'orderBy'?: { [key: string]: Array; } | null; /** * The fields to be used to sort the search results. * @type {Array} * @memberof CreateSavedSearchV1Request */ 'sort'?: Array | null; /** * * @type {SavedSearchDetailFilters} * @memberof CreateSavedSearchV1Request */ 'filters'?: SavedSearchDetailFilters | null; } /** * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. * @export * @enum {string} */ export declare const DtoType: { readonly AccountCorrelationConfig: "ACCOUNT_CORRELATION_CONFIG"; readonly AccessProfile: "ACCESS_PROFILE"; readonly AccessRequestApproval: "ACCESS_REQUEST_APPROVAL"; readonly Account: "ACCOUNT"; readonly Application: "APPLICATION"; readonly Campaign: "CAMPAIGN"; readonly CampaignFilter: "CAMPAIGN_FILTER"; readonly Certification: "CERTIFICATION"; readonly Cluster: "CLUSTER"; readonly ConnectorSchema: "CONNECTOR_SCHEMA"; readonly Entitlement: "ENTITLEMENT"; readonly GovernanceGroup: "GOVERNANCE_GROUP"; readonly Identity: "IDENTITY"; readonly IdentityProfile: "IDENTITY_PROFILE"; readonly IdentityRequest: "IDENTITY_REQUEST"; readonly MachineIdentity: "MACHINE_IDENTITY"; readonly LifecycleState: "LIFECYCLE_STATE"; readonly PasswordPolicy: "PASSWORD_POLICY"; readonly Role: "ROLE"; readonly Rule: "RULE"; readonly SodPolicy: "SOD_POLICY"; readonly Source: "SOURCE"; readonly Tag: "TAG"; readonly TagCategory: "TAG_CATEGORY"; readonly TaskResult: "TASK_RESULT"; readonly ReportResult: "REPORT_RESULT"; readonly SodViolation: "SOD_VIOLATION"; readonly AccountActivity: "ACCOUNT_ACTIVITY"; readonly Workgroup: "WORKGROUP"; }; export type DtoType = typeof DtoType[keyof typeof DtoType]; /** * * @export * @interface ErrorMessageDto */ export interface ErrorMessageDto { /** * The locale for the message text, a BCP 47 language tag. * @type {string} * @memberof ErrorMessageDto */ 'locale'?: string | null; /** * * @type {LocaleOrigin} * @memberof ErrorMessageDto */ 'localeOrigin'?: LocaleOrigin | null; /** * Actual text of the error message in the indicated locale. * @type {string} * @memberof ErrorMessageDto */ 'text'?: string; } /** * * @export * @interface ErrorResponseDto */ export interface ErrorResponseDto { /** * Fine-grained error code providing more detail of the error. * @type {string} * @memberof ErrorResponseDto */ 'detailCode'?: string; /** * Unique tracking id for the error. * @type {string} * @memberof ErrorResponseDto */ 'trackingId'?: string; /** * Generic localized reason for error * @type {Array} * @memberof ErrorResponseDto */ 'messages'?: Array; /** * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field * @type {Array} * @memberof ErrorResponseDto */ 'causes'?: Array; } /** * * @export * @interface Filter */ export interface Filter { /** * * @type {FilterType} * @memberof Filter */ 'type'?: FilterType; /** * * @type {Range} * @memberof Filter */ 'range'?: Range; /** * The terms to be filtered. * @type {Array} * @memberof Filter */ 'terms'?: Array; /** * Indicates if the filter excludes results. * @type {boolean} * @memberof Filter */ 'exclude'?: boolean; } /** * Enum representing the currently supported filter types. Additional values may be added in the future without notice. * @export * @enum {string} */ export declare const FilterType: { readonly Exists: "EXISTS"; readonly Range: "RANGE"; readonly Terms: "TERMS"; }; export type FilterType = typeof FilterType[keyof typeof FilterType]; /** * Enum representing the currently supported indices. Additional values may be added in the future without notice. * @export * @enum {string} */ export declare const Index: { readonly Accessprofiles: "accessprofiles"; readonly Accountactivities: "accountactivities"; readonly Entitlements: "entitlements"; readonly Events: "events"; readonly Identities: "identities"; readonly Roles: "roles"; readonly Star: "*"; }; export type Index = typeof Index[keyof typeof Index]; /** * * @export * @interface ListSavedSearchesV1401Response */ export interface ListSavedSearchesV1401Response { /** * A message describing the error * @type {any} * @memberof ListSavedSearchesV1401Response */ 'error'?: any; } /** * * @export * @interface ListSavedSearchesV1429Response */ export interface ListSavedSearchesV1429Response { /** * A message describing the error * @type {any} * @memberof ListSavedSearchesV1429Response */ 'message'?: any; } /** * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. * @export * @enum {string} */ export declare const LocaleOrigin: { readonly Default: "DEFAULT"; readonly Request: "REQUEST"; }; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * The range of values to be filtered. * @export * @interface Range */ export interface Range { /** * * @type {Bound} * @memberof Range */ 'lower'?: Bound; /** * * @type {Bound} * @memberof Range */ 'upper'?: Bound; } /** * * @export * @interface SavedSearch */ export interface SavedSearch { /** * The name of the saved search. * @type {string} * @memberof SavedSearch */ 'name'?: string; /** * The description of the saved search. * @type {string} * @memberof SavedSearch */ 'description'?: string | null; /** * A date-time in ISO-8601 format * @type {string} * @memberof SavedSearch */ 'created'?: string | null; /** * A date-time in ISO-8601 format * @type {string} * @memberof SavedSearch */ 'modified'?: string | null; /** * The names of the Elasticsearch indices in which to search. * @type {Array} * @memberof SavedSearch */ 'indices': Array; /** * The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. * @type {{ [key: string]: Array; }} * @memberof SavedSearch */ 'columns'?: { [key: string]: Array; }; /** * The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. * @type {string} * @memberof SavedSearch */ 'query': string; /** * The fields to be searched against in a multi-field query. * @type {Array} * @memberof SavedSearch */ 'fields'?: Array | null; /** * Sort by index. This takes precedence over the `sort` property. * @type {{ [key: string]: Array; }} * @memberof SavedSearch */ 'orderBy'?: { [key: string]: Array; } | null; /** * The fields to be used to sort the search results. * @type {Array} * @memberof SavedSearch */ 'sort'?: Array | null; /** * * @type {SavedSearchDetailFilters} * @memberof SavedSearch */ 'filters'?: SavedSearchDetailFilters | null; /** * The saved search ID. * @type {string} * @memberof SavedSearch */ 'id'?: string; /** * * @type {TypedReference} * @memberof SavedSearch */ 'owner'?: TypedReference; /** * The ID of the identity that owns this saved search. * @type {string} * @memberof SavedSearch */ 'ownerId'?: string; /** * Whether this saved search is visible to anyone but the owner. This field will always be false as there is no way to set a saved search as public at this time. * @type {boolean} * @memberof SavedSearch */ 'public'?: boolean; } /** * * @export * @interface SavedSearchDetail */ export interface SavedSearchDetail { /** * A date-time in ISO-8601 format * @type {string} * @memberof SavedSearchDetail */ 'created'?: string | null; /** * A date-time in ISO-8601 format * @type {string} * @memberof SavedSearchDetail */ 'modified'?: string | null; /** * The names of the Elasticsearch indices in which to search. * @type {Array} * @memberof SavedSearchDetail */ 'indices': Array; /** * The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. * @type {{ [key: string]: Array; }} * @memberof SavedSearchDetail */ 'columns'?: { [key: string]: Array; }; /** * The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. * @type {string} * @memberof SavedSearchDetail */ 'query': string; /** * The fields to be searched against in a multi-field query. * @type {Array} * @memberof SavedSearchDetail */ 'fields'?: Array | null; /** * Sort by index. This takes precedence over the `sort` property. * @type {{ [key: string]: Array; }} * @memberof SavedSearchDetail */ 'orderBy'?: { [key: string]: Array; } | null; /** * The fields to be used to sort the search results. * @type {Array} * @memberof SavedSearchDetail */ 'sort'?: Array | null; /** * * @type {SavedSearchDetailFilters} * @memberof SavedSearchDetail */ 'filters'?: SavedSearchDetailFilters | null; } /** * * @export * @interface SavedSearchDetailFilters */ export interface SavedSearchDetailFilters { /** * * @type {FilterType} * @memberof SavedSearchDetailFilters */ 'type'?: FilterType; /** * * @type {Range} * @memberof SavedSearchDetailFilters */ 'range'?: Range; /** * The terms to be filtered. * @type {Array} * @memberof SavedSearchDetailFilters */ 'terms'?: Array; /** * Indicates if the filter excludes results. * @type {boolean} * @memberof SavedSearchDetailFilters */ 'exclude'?: boolean; } /** * * @export * @interface SavedSearchName */ export interface SavedSearchName { /** * The name of the saved search. * @type {string} * @memberof SavedSearchName */ 'name'?: string; /** * The description of the saved search. * @type {string} * @memberof SavedSearchName */ 'description'?: string | null; } /** * * @export * @interface SearchArguments */ export interface SearchArguments { /** * The ID of the scheduled search that triggered the saved search execution. * @type {string} * @memberof SearchArguments */ 'scheduleId'?: string; /** * The owner of the scheduled search being tested. * @type {TypedReference} * @memberof SearchArguments */ 'owner'?: TypedReference; /** * The email recipients of the scheduled search being tested. * @type {Array} * @memberof SearchArguments */ 'recipients'?: Array; } /** * A typed reference to the object. * @export * @interface TypedReference */ export interface TypedReference { /** * * @type {DtoType} * @memberof TypedReference */ 'type': DtoType; /** * The id of the object. * @type {string} * @memberof TypedReference */ 'id': string; } /** * SavedSearchApi - axios parameter creator * @export */ export declare const SavedSearchApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a new saved search. * @summary Create a saved search * @param {CreateSavedSearchV1Request} createSavedSearchV1Request The saved search to persist. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSavedSearchV1: (createSavedSearchV1Request: CreateSavedSearchV1Request, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Deletes the specified saved search. * @summary Delete document by id * @param {string} id ID of the requested document. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteSavedSearchV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Executes the specified saved search. * @summary Execute a saved search by id * @param {string} id ID of the requested document. * @param {SearchArguments} searchArguments When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ executeSavedSearchV1: (id: string, searchArguments: SearchArguments, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Returns the specified saved search. * @summary Return saved search by id * @param {string} id ID of the requested document. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSavedSearchV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Returns a list of saved searches. * @summary A list of saved searches * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listSavedSearchesV1: (offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Updates an existing saved search. >**NOTE: You cannot update the `owner` of the saved search.** * @summary Updates an existing saved search * @param {string} id ID of the requested document. * @param {SavedSearch} savedSearch The saved search to persist. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putSavedSearchV1: (id: string, savedSearch: SavedSearch, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * SavedSearchApi - functional programming interface * @export */ export declare const SavedSearchApiFp: (configuration?: Configuration) => { /** * Creates a new saved search. * @summary Create a saved search * @param {CreateSavedSearchV1Request} createSavedSearchV1Request The saved search to persist. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSavedSearchV1(createSavedSearchV1Request: CreateSavedSearchV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes the specified saved search. * @summary Delete document by id * @param {string} id ID of the requested document. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteSavedSearchV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Executes the specified saved search. * @summary Execute a saved search by id * @param {string} id ID of the requested document. * @param {SearchArguments} searchArguments When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ executeSavedSearchV1(id: string, searchArguments: SearchArguments, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the specified saved search. * @summary Return saved search by id * @param {string} id ID of the requested document. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSavedSearchV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a list of saved searches. * @summary A list of saved searches * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listSavedSearchesV1(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Updates an existing saved search. >**NOTE: You cannot update the `owner` of the saved search.** * @summary Updates an existing saved search * @param {string} id ID of the requested document. * @param {SavedSearch} savedSearch The saved search to persist. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putSavedSearchV1(id: string, savedSearch: SavedSearch, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SavedSearchApi - factory interface * @export */ export declare const SavedSearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a new saved search. * @summary Create a saved search * @param {SavedSearchApiCreateSavedSearchV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSavedSearchV1(requestParameters: SavedSearchApiCreateSavedSearchV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes the specified saved search. * @summary Delete document by id * @param {SavedSearchApiDeleteSavedSearchV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteSavedSearchV1(requestParameters: SavedSearchApiDeleteSavedSearchV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Executes the specified saved search. * @summary Execute a saved search by id * @param {SavedSearchApiExecuteSavedSearchV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ executeSavedSearchV1(requestParameters: SavedSearchApiExecuteSavedSearchV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the specified saved search. * @summary Return saved search by id * @param {SavedSearchApiGetSavedSearchV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSavedSearchV1(requestParameters: SavedSearchApiGetSavedSearchV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a list of saved searches. * @summary A list of saved searches * @param {SavedSearchApiListSavedSearchesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listSavedSearchesV1(requestParameters?: SavedSearchApiListSavedSearchesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * Updates an existing saved search. >**NOTE: You cannot update the `owner` of the saved search.** * @summary Updates an existing saved search * @param {SavedSearchApiPutSavedSearchV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putSavedSearchV1(requestParameters: SavedSearchApiPutSavedSearchV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createSavedSearchV1 operation in SavedSearchApi. * @export * @interface SavedSearchApiCreateSavedSearchV1Request */ export interface SavedSearchApiCreateSavedSearchV1Request { /** * The saved search to persist. * @type {CreateSavedSearchV1Request} * @memberof SavedSearchApiCreateSavedSearchV1 */ readonly createSavedSearchV1Request: CreateSavedSearchV1Request; } /** * Request parameters for deleteSavedSearchV1 operation in SavedSearchApi. * @export * @interface SavedSearchApiDeleteSavedSearchV1Request */ export interface SavedSearchApiDeleteSavedSearchV1Request { /** * ID of the requested document. * @type {string} * @memberof SavedSearchApiDeleteSavedSearchV1 */ readonly id: string; } /** * Request parameters for executeSavedSearchV1 operation in SavedSearchApi. * @export * @interface SavedSearchApiExecuteSavedSearchV1Request */ export interface SavedSearchApiExecuteSavedSearchV1Request { /** * ID of the requested document. * @type {string} * @memberof SavedSearchApiExecuteSavedSearchV1 */ readonly id: string; /** * When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. * @type {SearchArguments} * @memberof SavedSearchApiExecuteSavedSearchV1 */ readonly searchArguments: SearchArguments; } /** * Request parameters for getSavedSearchV1 operation in SavedSearchApi. * @export * @interface SavedSearchApiGetSavedSearchV1Request */ export interface SavedSearchApiGetSavedSearchV1Request { /** * ID of the requested document. * @type {string} * @memberof SavedSearchApiGetSavedSearchV1 */ readonly id: string; } /** * Request parameters for listSavedSearchesV1 operation in SavedSearchApi. * @export * @interface SavedSearchApiListSavedSearchesV1Request */ export interface SavedSearchApiListSavedSearchesV1Request { /** * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof SavedSearchApiListSavedSearchesV1 */ readonly offset?: number; /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof SavedSearchApiListSavedSearchesV1 */ readonly limit?: number; /** * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {boolean} * @memberof SavedSearchApiListSavedSearchesV1 */ readonly count?: boolean; /** * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* * @type {string} * @memberof SavedSearchApiListSavedSearchesV1 */ readonly filters?: string; } /** * Request parameters for putSavedSearchV1 operation in SavedSearchApi. * @export * @interface SavedSearchApiPutSavedSearchV1Request */ export interface SavedSearchApiPutSavedSearchV1Request { /** * ID of the requested document. * @type {string} * @memberof SavedSearchApiPutSavedSearchV1 */ readonly id: string; /** * The saved search to persist. * @type {SavedSearch} * @memberof SavedSearchApiPutSavedSearchV1 */ readonly savedSearch: SavedSearch; } /** * SavedSearchApi - object-oriented interface * @export * @class SavedSearchApi * @extends {BaseAPI} */ export declare class SavedSearchApi extends BaseAPI { /** * Creates a new saved search. * @summary Create a saved search * @param {SavedSearchApiCreateSavedSearchV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SavedSearchApi */ createSavedSearchV1(requestParameters: SavedSearchApiCreateSavedSearchV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Deletes the specified saved search. * @summary Delete document by id * @param {SavedSearchApiDeleteSavedSearchV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SavedSearchApi */ deleteSavedSearchV1(requestParameters: SavedSearchApiDeleteSavedSearchV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Executes the specified saved search. * @summary Execute a saved search by id * @param {SavedSearchApiExecuteSavedSearchV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SavedSearchApi */ executeSavedSearchV1(requestParameters: SavedSearchApiExecuteSavedSearchV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Returns the specified saved search. * @summary Return saved search by id * @param {SavedSearchApiGetSavedSearchV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SavedSearchApi */ getSavedSearchV1(requestParameters: SavedSearchApiGetSavedSearchV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Returns a list of saved searches. * @summary A list of saved searches * @param {SavedSearchApiListSavedSearchesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SavedSearchApi */ listSavedSearchesV1(requestParameters?: SavedSearchApiListSavedSearchesV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Updates an existing saved search. >**NOTE: You cannot update the `owner` of the saved search.** * @summary Updates an existing saved search * @param {SavedSearchApiPutSavedSearchV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SavedSearchApi */ putSavedSearchV1(requestParameters: SavedSearchApiPutSavedSearchV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; }