import type { AxiosRequestConfig } from 'axios'; import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; import type { GetRemediations200Response, GetRemediationsFieldsDataParameter, GetRemediationsFilterParameter } from '../types'; export type GetRemediationsParams = { /** * Sort order. Use `-` before a field name for descending order (e.g., `?-system_count`). * @type { GetRemediationsSortEnum } * @memberof GetRemediationsApi */ sort?: GetRemediationsSortEnum; /** * For filtering by various criteria. There are two styles of filter: legacy and new. Legacy filtering allows for filtering by remediation plan name and is of the form: `?filter=plan name`. If specified, only remediations whose name matches the given string will be returned. New style filters allow for filtering by various criteria and are of the form: `?filter[]=`. Available filter fields: - name: plan names matching string, `?filter[name]=my plan name` - created_after: created on or after date-time, `filter[created_after]=2025-03-31T08:19:36.641Z` - updated_after: modified on or after date-time, `filter[updated_after]=2025-03-31T08:19:36.641Z` - last_run_after: executed on or after date-time or \'never\', `filter[last_run_after]=never` - status: status matching one of [running, success, failure], `filter[status]=failure` * @type { GetRemediationsFilterParameter } * @memberof GetRemediationsApi */ filter?: GetRemediationsFilterParameter; /** * Maximum number of results to return * @type { number } * @memberof GetRemediationsApi */ limit?: number; /** * Indicates the starting position of the query relative to the complete set of items that match the query * @type { number } * @memberof GetRemediationsApi */ offset?: number; /** * System identifier. If specified only remediations that involve the given system will be returned. * @type { string } * @memberof GetRemediationsApi */ system?: string; /** * Hide archived playbooks * @type { boolean } * @memberof GetRemediationsApi */ hideArchived?: boolean; /** * Include specified items - name: list all remediation plan names and IDs in organization (cannot be combined with other fields) - playbook_runs: include playbook run data in the response (cannot be combined with other fields) - last_playbook_run: include latest playbook run summary in the response (cannot be combined with other fields) * @type { GetRemediationsFieldsDataParameter } * @memberof GetRemediationsApi */ fieldsData?: GetRemediationsFieldsDataParameter; options?: AxiosRequestConfig; }; /** * @export * @enum {string} */ export declare const GetRemediationsSortEnum: { readonly UpdatedAt: "updated_at"; readonly NotUpdatedAt: "-updated_at"; readonly CreatedAt: "created_at"; readonly NotCreatedAt: "-created_at"; readonly LastRunAt: "last_run_at"; readonly NotLastRunAt: "-last_run_at"; readonly Name: "name"; readonly NotName: "-name"; readonly SystemCount: "system_count"; readonly NotSystemCount: "-system_count"; readonly IssueCount: "issue_count"; readonly NotIssueCount: "-issue_count"; readonly Status: "status"; readonly NotStatus: "-status"; }; export type GetRemediationsSortEnum = typeof GetRemediationsSortEnum[keyof typeof GetRemediationsSortEnum]; export type GetRemediationsReturnType = GetRemediations200Response; /** * Provides information about Remediations, RBAC permission {remediations:remediation:read} * @summary List Remediations * @param {GetRemediationsParams} config with all available params. * @param {*} [options] Override http request option. * @throws {RequiredError} */ export declare const getRemediationsParamCreator: (sendRequest: BaseAPI["sendRequest"], ...config: ([GetRemediationsParams] | [GetRemediationsSortEnum, GetRemediationsFilterParameter, number, number, string, boolean, GetRemediationsFieldsDataParameter, AxiosRequestConfig])) => Promise>; export default getRemediationsParamCreator; //# sourceMappingURL=index.d.ts.map