/** * Identity Security Cloud API - Scheduled 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 CreateScheduledSearchV1Request */ export interface CreateScheduledSearchV1Request { /** * The name of the scheduled search. * @type {string} * @memberof CreateScheduledSearchV1Request */ 'name'?: string | null; /** * The description of the scheduled search. * @type {string} * @memberof CreateScheduledSearchV1Request */ 'description'?: string | null; /** * The ID of the saved search that will be executed. * @type {string} * @memberof CreateScheduledSearchV1Request */ 'savedSearchId': string; /** * The date the scheduled search was initially created. * @type {string} * @memberof CreateScheduledSearchV1Request */ 'created'?: string | null; /** * The last date the scheduled search was modified. * @type {string} * @memberof CreateScheduledSearchV1Request */ 'modified'?: string | null; /** * * @type {Schedule} * @memberof CreateScheduledSearchV1Request */ 'schedule': Schedule; /** * A list of identities that should receive the scheduled search report via email. * @type {Array} * @memberof CreateScheduledSearchV1Request */ 'recipients': Array; /** * Indicates if the scheduled search is enabled. * @type {boolean} * @memberof CreateScheduledSearchV1Request */ 'enabled'?: boolean; /** * Indicates if email generation should occur when search returns no results. * @type {boolean} * @memberof CreateScheduledSearchV1Request */ 'emailEmptyResults'?: boolean; /** * Indicates if the generated email should include the query and search results preview (which could include PII). * @type {boolean} * @memberof CreateScheduledSearchV1Request */ 'displayQueryDetails'?: boolean; } /** * 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 ListScheduledSearchV1401Response */ export interface ListScheduledSearchV1401Response { /** * A message describing the error * @type {any} * @memberof ListScheduledSearchV1401Response */ 'error'?: any; } /** * * @export * @interface ListScheduledSearchV1429Response */ export interface ListScheduledSearchV1429Response { /** * A message describing the error * @type {any} * @memberof ListScheduledSearchV1429Response */ '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 schedule information. * @export * @interface Schedule */ export interface Schedule { /** * * @type {ScheduleType} * @memberof Schedule */ 'type': ScheduleType; /** * * @type {ScheduleMonths} * @memberof Schedule */ 'months'?: ScheduleMonths; /** * * @type {ScheduleDays} * @memberof Schedule */ 'days'?: ScheduleDays; /** * * @type {ScheduleHours} * @memberof Schedule */ 'hours': ScheduleHours; /** * A date-time in ISO-8601 format * @type {string} * @memberof Schedule */ 'expiration'?: string | null; /** * The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org\'s default timezone is used. * @type {string} * @memberof Schedule */ 'timeZoneId'?: string | null; } /** * * @export * @interface ScheduleDays */ export interface ScheduleDays { /** * * @type {SelectorType} * @memberof ScheduleDays */ 'type': SelectorType; /** * The selected values. * @type {Array} * @memberof ScheduleDays */ 'values': Array; /** * The selected interval for RANGE selectors. * @type {number} * @memberof ScheduleDays */ 'interval'?: number | null; } /** * * @export * @interface ScheduleHours */ export interface ScheduleHours { /** * * @type {SelectorType} * @memberof ScheduleHours */ 'type': SelectorType; /** * The selected values. * @type {Array} * @memberof ScheduleHours */ 'values': Array; /** * The selected interval for RANGE selectors. * @type {number} * @memberof ScheduleHours */ 'interval'?: number | null; } /** * * @export * @interface ScheduleMonths */ export interface ScheduleMonths { /** * * @type {SelectorType} * @memberof ScheduleMonths */ 'type': SelectorType; /** * The selected values. * @type {Array} * @memberof ScheduleMonths */ 'values': Array; /** * The selected interval for RANGE selectors. * @type {number} * @memberof ScheduleMonths */ 'interval'?: number | null; } /** * Enum representing the currently supported schedule types. Additional values may be added in the future without notice. * @export * @enum {string} */ export declare const ScheduleType: { readonly Daily: "DAILY"; readonly Weekly: "WEEKLY"; readonly Monthly: "MONTHLY"; readonly Calendar: "CALENDAR"; readonly Annually: "ANNUALLY"; }; export type ScheduleType = typeof ScheduleType[keyof typeof ScheduleType]; /** * * @export * @interface ScheduledSearch */ export interface ScheduledSearch { /** * The name of the scheduled search. * @type {string} * @memberof ScheduledSearch */ 'name'?: string | null; /** * The description of the scheduled search. * @type {string} * @memberof ScheduledSearch */ 'description'?: string | null; /** * The ID of the saved search that will be executed. * @type {string} * @memberof ScheduledSearch */ 'savedSearchId': string; /** * The date the scheduled search was initially created. * @type {string} * @memberof ScheduledSearch */ 'created'?: string | null; /** * The last date the scheduled search was modified. * @type {string} * @memberof ScheduledSearch */ 'modified'?: string | null; /** * * @type {Schedule} * @memberof ScheduledSearch */ 'schedule': Schedule; /** * A list of identities that should receive the scheduled search report via email. * @type {Array} * @memberof ScheduledSearch */ 'recipients': Array; /** * Indicates if the scheduled search is enabled. * @type {boolean} * @memberof ScheduledSearch */ 'enabled'?: boolean; /** * Indicates if email generation should occur when search returns no results. * @type {boolean} * @memberof ScheduledSearch */ 'emailEmptyResults'?: boolean; /** * Indicates if the generated email should include the query and search results preview (which could include PII). * @type {boolean} * @memberof ScheduledSearch */ 'displayQueryDetails'?: boolean; /** * The scheduled search ID. * @type {string} * @memberof ScheduledSearch */ 'id': string; /** * * @type {ScheduledSearchAllOfOwner} * @memberof ScheduledSearch */ 'owner': ScheduledSearchAllOfOwner; /** * The ID of the scheduled search owner. Please use the `id` in the `owner` object instead. * @type {string} * @memberof ScheduledSearch * @deprecated */ 'ownerId': string; } /** * The owner of the scheduled search * @export * @interface ScheduledSearchAllOfOwner */ export interface ScheduledSearchAllOfOwner { /** * The type of object being referenced * @type {string} * @memberof ScheduledSearchAllOfOwner */ 'type': ScheduledSearchAllOfOwnerTypeEnum; /** * The ID of the referenced object * @type {string} * @memberof ScheduledSearchAllOfOwner */ 'id': string; } export declare const ScheduledSearchAllOfOwnerTypeEnum: { readonly Identity: "IDENTITY"; }; export type ScheduledSearchAllOfOwnerTypeEnum = typeof ScheduledSearchAllOfOwnerTypeEnum[keyof typeof ScheduledSearchAllOfOwnerTypeEnum]; /** * * @export * @interface ScheduledSearchName */ export interface ScheduledSearchName { /** * The name of the scheduled search. * @type {string} * @memberof ScheduledSearchName */ 'name'?: string | null; /** * The description of the scheduled search. * @type {string} * @memberof ScheduledSearchName */ 'description'?: string | null; } /** * * @export * @interface SearchSchedule */ export interface SearchSchedule { /** * The ID of the saved search that will be executed. * @type {string} * @memberof SearchSchedule */ 'savedSearchId': string; /** * The date the scheduled search was initially created. * @type {string} * @memberof SearchSchedule */ 'created'?: string | null; /** * The last date the scheduled search was modified. * @type {string} * @memberof SearchSchedule */ 'modified'?: string | null; /** * * @type {Schedule} * @memberof SearchSchedule */ 'schedule': Schedule; /** * A list of identities that should receive the scheduled search report via email. * @type {Array} * @memberof SearchSchedule */ 'recipients': Array; /** * Indicates if the scheduled search is enabled. * @type {boolean} * @memberof SearchSchedule */ 'enabled'?: boolean; /** * Indicates if email generation should occur when search returns no results. * @type {boolean} * @memberof SearchSchedule */ 'emailEmptyResults'?: boolean; /** * Indicates if the generated email should include the query and search results preview (which could include PII). * @type {boolean} * @memberof SearchSchedule */ 'displayQueryDetails'?: boolean; } /** * * @export * @interface SearchScheduleRecipientsInner */ export interface SearchScheduleRecipientsInner { /** * The type of object being referenced * @type {string} * @memberof SearchScheduleRecipientsInner */ 'type': SearchScheduleRecipientsInnerTypeEnum; /** * The ID of the referenced object * @type {string} * @memberof SearchScheduleRecipientsInner */ 'id': string; } export declare const SearchScheduleRecipientsInnerTypeEnum: { readonly Identity: "IDENTITY"; }; export type SearchScheduleRecipientsInnerTypeEnum = typeof SearchScheduleRecipientsInnerTypeEnum[keyof typeof SearchScheduleRecipientsInnerTypeEnum]; /** * * @export * @interface Selector */ export interface Selector { /** * * @type {SelectorType} * @memberof Selector */ 'type': SelectorType; /** * The selected values. * @type {Array} * @memberof Selector */ 'values': Array; /** * The selected interval for RANGE selectors. * @type {number} * @memberof Selector */ 'interval'?: number | null; } /** * Enum representing the currently supported selector types. LIST - the *values* array contains one or more distinct values. RANGE - the *values* array contains two values: the start and end of the range, inclusive. Additional values may be added in the future without notice. * @export * @enum {string} */ export declare const SelectorType: { readonly List: "LIST"; readonly Range: "RANGE"; }; export type SelectorType = typeof SelectorType[keyof typeof SelectorType]; /** * 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; } /** * ScheduledSearchApi - axios parameter creator * @export */ export declare const ScheduledSearchApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a new scheduled search. * @summary Create a new scheduled search * @param {CreateScheduledSearchV1Request} createScheduledSearchV1Request The scheduled search to persist. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createScheduledSearchV1: (createScheduledSearchV1Request: CreateScheduledSearchV1Request, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Deletes the specified scheduled search. * @summary Delete a scheduled search * @param {string} id ID of the requested document. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteScheduledSearchV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Returns the specified scheduled search. * @summary Get a scheduled search * @param {string} id ID of the requested document. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getScheduledSearchV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Returns a list of scheduled searches. * @summary List scheduled 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* **savedSearchId**: *eq* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listScheduledSearchV1: (offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Unsubscribes a recipient from the specified scheduled search. * @summary Unsubscribe a recipient from scheduled search * @param {string} id ID of the requested document. * @param {TypedReference} typedReference The recipient to be removed from the scheduled search. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ unsubscribeScheduledSearchV1: (id: string, typedReference: TypedReference, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Updates an existing scheduled search. * @summary Update an existing scheduled search * @param {string} id ID of the requested document. * @param {ScheduledSearch} scheduledSearch The scheduled search to persist. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateScheduledSearchV1: (id: string, scheduledSearch: ScheduledSearch, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * ScheduledSearchApi - functional programming interface * @export */ export declare const ScheduledSearchApiFp: (configuration?: Configuration) => { /** * Creates a new scheduled search. * @summary Create a new scheduled search * @param {CreateScheduledSearchV1Request} createScheduledSearchV1Request The scheduled search to persist. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createScheduledSearchV1(createScheduledSearchV1Request: CreateScheduledSearchV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes the specified scheduled search. * @summary Delete a scheduled search * @param {string} id ID of the requested document. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteScheduledSearchV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the specified scheduled search. * @summary Get a scheduled search * @param {string} id ID of the requested document. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getScheduledSearchV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a list of scheduled searches. * @summary List scheduled 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* **savedSearchId**: *eq* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listScheduledSearchV1(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Unsubscribes a recipient from the specified scheduled search. * @summary Unsubscribe a recipient from scheduled search * @param {string} id ID of the requested document. * @param {TypedReference} typedReference The recipient to be removed from the scheduled search. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ unsubscribeScheduledSearchV1(id: string, typedReference: TypedReference, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates an existing scheduled search. * @summary Update an existing scheduled search * @param {string} id ID of the requested document. * @param {ScheduledSearch} scheduledSearch The scheduled search to persist. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateScheduledSearchV1(id: string, scheduledSearch: ScheduledSearch, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ScheduledSearchApi - factory interface * @export */ export declare const ScheduledSearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a new scheduled search. * @summary Create a new scheduled search * @param {ScheduledSearchApiCreateScheduledSearchV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createScheduledSearchV1(requestParameters: ScheduledSearchApiCreateScheduledSearchV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes the specified scheduled search. * @summary Delete a scheduled search * @param {ScheduledSearchApiDeleteScheduledSearchV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteScheduledSearchV1(requestParameters: ScheduledSearchApiDeleteScheduledSearchV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the specified scheduled search. * @summary Get a scheduled search * @param {ScheduledSearchApiGetScheduledSearchV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getScheduledSearchV1(requestParameters: ScheduledSearchApiGetScheduledSearchV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a list of scheduled searches. * @summary List scheduled searches * @param {ScheduledSearchApiListScheduledSearchV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listScheduledSearchV1(requestParameters?: ScheduledSearchApiListScheduledSearchV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * Unsubscribes a recipient from the specified scheduled search. * @summary Unsubscribe a recipient from scheduled search * @param {ScheduledSearchApiUnsubscribeScheduledSearchV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ unsubscribeScheduledSearchV1(requestParameters: ScheduledSearchApiUnsubscribeScheduledSearchV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Updates an existing scheduled search. * @summary Update an existing scheduled search * @param {ScheduledSearchApiUpdateScheduledSearchV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateScheduledSearchV1(requestParameters: ScheduledSearchApiUpdateScheduledSearchV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createScheduledSearchV1 operation in ScheduledSearchApi. * @export * @interface ScheduledSearchApiCreateScheduledSearchV1Request */ export interface ScheduledSearchApiCreateScheduledSearchV1Request { /** * The scheduled search to persist. * @type {CreateScheduledSearchV1Request} * @memberof ScheduledSearchApiCreateScheduledSearchV1 */ readonly createScheduledSearchV1Request: CreateScheduledSearchV1Request; } /** * Request parameters for deleteScheduledSearchV1 operation in ScheduledSearchApi. * @export * @interface ScheduledSearchApiDeleteScheduledSearchV1Request */ export interface ScheduledSearchApiDeleteScheduledSearchV1Request { /** * ID of the requested document. * @type {string} * @memberof ScheduledSearchApiDeleteScheduledSearchV1 */ readonly id: string; } /** * Request parameters for getScheduledSearchV1 operation in ScheduledSearchApi. * @export * @interface ScheduledSearchApiGetScheduledSearchV1Request */ export interface ScheduledSearchApiGetScheduledSearchV1Request { /** * ID of the requested document. * @type {string} * @memberof ScheduledSearchApiGetScheduledSearchV1 */ readonly id: string; } /** * Request parameters for listScheduledSearchV1 operation in ScheduledSearchApi. * @export * @interface ScheduledSearchApiListScheduledSearchV1Request */ export interface ScheduledSearchApiListScheduledSearchV1Request { /** * 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 ScheduledSearchApiListScheduledSearchV1 */ 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 ScheduledSearchApiListScheduledSearchV1 */ 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 ScheduledSearchApiListScheduledSearchV1 */ 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* **savedSearchId**: *eq* * @type {string} * @memberof ScheduledSearchApiListScheduledSearchV1 */ readonly filters?: string; } /** * Request parameters for unsubscribeScheduledSearchV1 operation in ScheduledSearchApi. * @export * @interface ScheduledSearchApiUnsubscribeScheduledSearchV1Request */ export interface ScheduledSearchApiUnsubscribeScheduledSearchV1Request { /** * ID of the requested document. * @type {string} * @memberof ScheduledSearchApiUnsubscribeScheduledSearchV1 */ readonly id: string; /** * The recipient to be removed from the scheduled search. * @type {TypedReference} * @memberof ScheduledSearchApiUnsubscribeScheduledSearchV1 */ readonly typedReference: TypedReference; } /** * Request parameters for updateScheduledSearchV1 operation in ScheduledSearchApi. * @export * @interface ScheduledSearchApiUpdateScheduledSearchV1Request */ export interface ScheduledSearchApiUpdateScheduledSearchV1Request { /** * ID of the requested document. * @type {string} * @memberof ScheduledSearchApiUpdateScheduledSearchV1 */ readonly id: string; /** * The scheduled search to persist. * @type {ScheduledSearch} * @memberof ScheduledSearchApiUpdateScheduledSearchV1 */ readonly scheduledSearch: ScheduledSearch; } /** * ScheduledSearchApi - object-oriented interface * @export * @class ScheduledSearchApi * @extends {BaseAPI} */ export declare class ScheduledSearchApi extends BaseAPI { /** * Creates a new scheduled search. * @summary Create a new scheduled search * @param {ScheduledSearchApiCreateScheduledSearchV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ScheduledSearchApi */ createScheduledSearchV1(requestParameters: ScheduledSearchApiCreateScheduledSearchV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Deletes the specified scheduled search. * @summary Delete a scheduled search * @param {ScheduledSearchApiDeleteScheduledSearchV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ScheduledSearchApi */ deleteScheduledSearchV1(requestParameters: ScheduledSearchApiDeleteScheduledSearchV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Returns the specified scheduled search. * @summary Get a scheduled search * @param {ScheduledSearchApiGetScheduledSearchV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ScheduledSearchApi */ getScheduledSearchV1(requestParameters: ScheduledSearchApiGetScheduledSearchV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Returns a list of scheduled searches. * @summary List scheduled searches * @param {ScheduledSearchApiListScheduledSearchV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ScheduledSearchApi */ listScheduledSearchV1(requestParameters?: ScheduledSearchApiListScheduledSearchV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Unsubscribes a recipient from the specified scheduled search. * @summary Unsubscribe a recipient from scheduled search * @param {ScheduledSearchApiUnsubscribeScheduledSearchV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ScheduledSearchApi */ unsubscribeScheduledSearchV1(requestParameters: ScheduledSearchApiUnsubscribeScheduledSearchV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Updates an existing scheduled search. * @summary Update an existing scheduled search * @param {ScheduledSearchApiUpdateScheduledSearchV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ScheduledSearchApi */ updateScheduledSearchV1(requestParameters: ScheduledSearchApiUpdateScheduledSearchV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; }