import type { AxiosRequestConfig } from 'axios'; import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; import type { PaginatedRuleForAccountList } from '../types'; export type RuleListParams = { /** * Display rules of this category (number) * @type { Array } * @memberof RuleListApi */ category?: Array; /** * Is this an Ansible system? * @type { boolean } * @memberof RuleListApi */ filterSystemProfileAnsible?: boolean; /** * Is this a Microsoft SQL system? * @type { boolean } * @memberof RuleListApi */ filterSystemProfileMssql?: boolean; /** * Are there systems which contain these SAP SIDs? * @type { Array } * @memberof RuleListApi */ filterSystemProfileSapSidsContains?: Array; /** * Is this a SAP system? * @type { boolean } * @memberof RuleListApi */ filterSystemProfileSapSystem?: boolean; /** * List of Inventory host group names * @type { Array } * @memberof RuleListApi */ groups?: Array; /** * Display rules that have a playbook * @type { boolean } * @memberof RuleListApi */ hasPlaybook?: boolean; /** * Display rules that have (one or more) tags * @type { Array } * @memberof RuleListApi */ hasTag?: Array; /** * Display rules of this impact level (1..4) * @type { Array } * @memberof RuleListApi */ impact?: Array; /** * Display only rules that are impacting systems currently * @type { boolean } * @memberof RuleListApi */ impacting?: boolean; /** * Display only rules that cause an incident * @type { boolean } * @memberof RuleListApi */ incident?: boolean; /** * Display only rules of this likelihood level (1..4) * @type { Array } * @memberof RuleListApi */ likelihood?: Array; /** * Number of results to return per page. * @type { number } * @memberof RuleListApi */ limit?: number; /** * The initial index from which to return the results. * @type { number } * @memberof RuleListApi */ offset?: number; /** * Display rules of this Pathway * @type { string } * @memberof RuleListApi */ pathway?: string; /** * Display rules that require a reboot to fix * @type { boolean } * @memberof RuleListApi */ reboot?: boolean; /** * Display rules where reports are shown or not * @type { boolean } * @memberof RuleListApi */ reportsShown?: boolean; /** * Display rules with this resolution risk level (1..4) * @type { Array } * @memberof RuleListApi */ resRisk?: Array; /** * Display rules which are enabled, disabled (acked) by user, or disabled (acked) by Red Hat * @type { RuleListRuleStatusEnum } * @memberof RuleListApi */ ruleStatus?: RuleListRuleStatusEnum; /** * Order by this field * @type { Array } * @memberof RuleListApi */ sort?: Array; /** * Tags have a namespace, key and value in the form namespace/key=value * @type { Array } * @memberof RuleListApi */ tags?: Array; /** * Display rules with this text in their text fields * @type { string } * @memberof RuleListApi */ text?: string; /** * Display rules in this topic (slug) * @type { string } * @memberof RuleListApi */ topic?: string; /** * Display rules with this total risk level (1..4) * @type { Array } * @memberof RuleListApi */ totalRisk?: Array; /** * Search for systems with this updater type * @type { Array } * @memberof RuleListApi */ updateMethod?: Array; options?: AxiosRequestConfig; }; /** * @export * @enum {string} */ export declare const RuleListCategoryEnum: { readonly NUMBER_1: 1; readonly NUMBER_2: 2; readonly NUMBER_3: 3; readonly NUMBER_4: 4; }; export type RuleListCategoryEnum = typeof RuleListCategoryEnum[keyof typeof RuleListCategoryEnum]; /** * @export * @enum {string} */ export declare const RuleListImpactEnum: { readonly NUMBER_1: 1; readonly NUMBER_2: 2; readonly NUMBER_3: 3; readonly NUMBER_4: 4; }; export type RuleListImpactEnum = typeof RuleListImpactEnum[keyof typeof RuleListImpactEnum]; /** * @export * @enum {string} */ export declare const RuleListLikelihoodEnum: { readonly NUMBER_1: 1; readonly NUMBER_2: 2; readonly NUMBER_3: 3; readonly NUMBER_4: 4; }; export type RuleListLikelihoodEnum = typeof RuleListLikelihoodEnum[keyof typeof RuleListLikelihoodEnum]; /** * @export * @enum {string} */ export declare const RuleListResRiskEnum: { readonly NUMBER_1: 1; readonly NUMBER_2: 2; readonly NUMBER_3: 3; readonly NUMBER_4: 4; }; export type RuleListResRiskEnum = typeof RuleListResRiskEnum[keyof typeof RuleListResRiskEnum]; /** * @export * @enum {string} */ export declare const RuleListRuleStatusEnum: { readonly All: "all"; readonly Disabled: "disabled"; readonly Enabled: "enabled"; readonly Rhdisabled: "rhdisabled"; }; export type RuleListRuleStatusEnum = typeof RuleListRuleStatusEnum[keyof typeof RuleListRuleStatusEnum]; /** * @export * @enum {string} */ export declare const RuleListSortEnum: { readonly NotCategory: "-category"; readonly NotDescription: "-description"; readonly NotImpact: "-impact"; readonly NotImpactedCount: "-impacted_count"; readonly NotLikelihood: "-likelihood"; readonly NotPlaybookCount: "-playbook_count"; readonly NotPublishDate: "-publish_date"; readonly NotResolutionRisk: "-resolution_risk"; readonly NotRuleId: "-rule_id"; readonly NotTotalRisk: "-total_risk"; readonly Category: "category"; readonly Description: "description"; readonly Impact: "impact"; readonly ImpactedCount: "impacted_count"; readonly Likelihood: "likelihood"; readonly PlaybookCount: "playbook_count"; readonly PublishDate: "publish_date"; readonly ResolutionRisk: "resolution_risk"; readonly RuleId: "rule_id"; readonly TotalRisk: "total_risk"; }; export type RuleListSortEnum = typeof RuleListSortEnum[keyof typeof RuleListSortEnum]; /** * @export * @enum {string} */ export declare const RuleListTotalRiskEnum: { readonly NUMBER_1: 1; readonly NUMBER_2: 2; readonly NUMBER_3: 3; readonly NUMBER_4: 4; }; export type RuleListTotalRiskEnum = typeof RuleListTotalRiskEnum[keyof typeof RuleListTotalRiskEnum]; /** * @export * @enum {string} */ export declare const RuleListUpdateMethodEnum: { readonly Dnfyum: "dnfyum"; readonly Ostree: "ostree"; }; export type RuleListUpdateMethodEnum = typeof RuleListUpdateMethodEnum[keyof typeof RuleListUpdateMethodEnum]; export type RuleListReturnType = PaginatedRuleForAccountList; /** * List all active rules for this account. If \'acked\' is False or not given, then only rules that are not acked will be shown. If acked is set and \'true\' as a string or evaluates to a true value, then all rules including those that are acked will be shown. * @param {RuleListParams} config with all available params. * @param {*} [options] Override http request option. * @throws {RequiredError} */ export declare const ruleListParamCreator: (sendRequest: BaseAPI["sendRequest"], ...config: ([RuleListParams] | [Array, boolean, boolean, Array, boolean, Array, boolean, Array, Array, boolean, boolean, Array, number, number, string, boolean, boolean, Array, RuleListRuleStatusEnum, Array, Array, string, string, Array, Array, AxiosRequestConfig])) => Promise>; export default ruleListParamCreator; //# sourceMappingURL=index.d.ts.map