diff --git a/packages/insights/AccountHostsRetrieve/index.ts b/packages/insights/AccountHostsRetrieve/index.ts deleted file mode 100644 index ead11515d..000000000 --- a/packages/insights/AccountHostsRetrieve/index.ts +++ /dev/null @@ -1,65 +0,0 @@ -// @ts-ignore -import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios'; -// @ts-ignore -import { COLLECTION_FORMATS, RequiredError, AuthTypeEnum, DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; -import type { RequestArgs } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; -// @ts-ignore -import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; -import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; - -// @ts-ignore -import type { OrgId } from '../types'; - - -export type AccountHostsRetrieveParams = { - /** - * - * @type { string } - * @memberof AccountHostsRetrieveApi - */ - orgId: string, - options?: AxiosRequestConfig -} - -export type AccountHostsRetrieveReturnType = AxiosPromise; - -const isAccountHostsRetrieveObjectParams = (params: [AccountHostsRetrieveParams] | unknown[]): params is [AccountHostsRetrieveParams] => { - return params.length === 1 && Object.prototype.hasOwnProperty.call(params, 'orgId') -} -/** -* List details about the number of hosts in this account by org_id. As well as the total number of hosts, we report on the number of hosts in various states of staleness: * fresh: hosts that have updated in the last 26 hours * stale: hosts not updated in the last 26 hours - we display the results for these hosts but a warning is shown to say they are not updating * warn: hosts not updated in the last week - these are not shown in any queries This may have other aggregate data added in the future. -* @param {AccountHostsRetrieveParams} config with all available params. -* @param {*} [options] Override http request option. -* @throws {RequiredError} -*/ -export const accountHostsRetrieveParamCreator = async (...config: ([AccountHostsRetrieveParams] | [string, AxiosRequestConfig])): Promise => { - const params = isAccountHostsRetrieveObjectParams(config) ? config[0] : ['orgId', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as AccountHostsRetrieveParams; - const { orgId, options = {} } = params; - const localVarPath = `/api/insights/v1/account/{org_id}/hosts/` - .replace(`{${"org_id"}}`, encodeURIComponent(String(orgId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - const localVarRequestOptions = { method: 'GET' as Method, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; - - return { - urlObj: localVarUrlObj, - options: localVarRequestOptions, - auth:[ - { - // authentication x-rh-identity required - // in header with key required - authType: AuthTypeEnum.InHeader, - authKey: "x-rh-identity" - } - ] - }; -} - -export default accountHostsRetrieveParamCreator; diff --git a/packages/insights/AccountList/index.ts b/packages/insights/AccountList/index.ts deleted file mode 100644 index b295085d0..000000000 --- a/packages/insights/AccountList/index.ts +++ /dev/null @@ -1,78 +0,0 @@ -// @ts-ignore -import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios'; -// @ts-ignore -import { COLLECTION_FORMATS, RequiredError, AuthTypeEnum, DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; -import type { RequestArgs } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; -// @ts-ignore -import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; -import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; - -// @ts-ignore -import type { PaginatedOrgIdList } from '../types'; - - -export type AccountListParams = { - /** - * Number of results to return per page. - * @type { number } - * @memberof AccountListApi - */ - limit?: number, - /** - * The initial index from which to return the results. - * @type { number } - * @memberof AccountListApi - */ - offset?: number, - options?: AxiosRequestConfig -} - -export type AccountListReturnType = AxiosPromise; - -const isAccountListObjectParams = (params: [AccountListParams] | unknown[]): params is [AccountListParams] => { - return params.length === 1 && true && true -} -/** -* List all accounts by org_id we know about (through the host table). No other information about the accounts is provided in this view. -* @param {AccountListParams} config with all available params. -* @param {*} [options] Override http request option. -* @throws {RequiredError} -*/ -export const accountListParamCreator = async (...config: ([AccountListParams] | [number, number, AxiosRequestConfig])): Promise => { - const params = isAccountListObjectParams(config) ? config[0] : ['limit', 'offset', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as AccountListParams; - const { limit, offset, options = {} } = params; - const localVarPath = `/api/insights/v1/account/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - const localVarRequestOptions = { method: 'GET' as Method, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; - - return { - urlObj: localVarUrlObj, - options: localVarRequestOptions, - auth:[ - { - // authentication x-rh-identity required - // in header with key required - authType: AuthTypeEnum.InHeader, - authKey: "x-rh-identity" - } - ] - }; -} - -export default accountListParamCreator; diff --git a/packages/insights/AccountRetrieve/index.ts b/packages/insights/AccountRetrieve/index.ts deleted file mode 100644 index b502c6af7..000000000 --- a/packages/insights/AccountRetrieve/index.ts +++ /dev/null @@ -1,65 +0,0 @@ -// @ts-ignore -import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios'; -// @ts-ignore -import { COLLECTION_FORMATS, RequiredError, AuthTypeEnum, DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; -import type { RequestArgs } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; -// @ts-ignore -import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; -import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; - -// @ts-ignore -import type { OrgId } from '../types'; - - -export type AccountRetrieveParams = { - /** - * - * @type { string } - * @memberof AccountRetrieveApi - */ - orgId: string, - options?: AxiosRequestConfig -} - -export type AccountRetrieveReturnType = AxiosPromise; - -const isAccountRetrieveObjectParams = (params: [AccountRetrieveParams] | unknown[]): params is [AccountRetrieveParams] => { - return params.length === 1 && Object.prototype.hasOwnProperty.call(params, 'orgId') -} -/** -* List information relating to other accounts. This allows us to collect data that requires the user to specify an org_id number, such as number of systems currently registered to that org. param: org_id: Org ID number of a Red Hat customer. -* @param {AccountRetrieveParams} config with all available params. -* @param {*} [options] Override http request option. -* @throws {RequiredError} -*/ -export const accountRetrieveParamCreator = async (...config: ([AccountRetrieveParams] | [string, AxiosRequestConfig])): Promise => { - const params = isAccountRetrieveObjectParams(config) ? config[0] : ['orgId', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as AccountRetrieveParams; - const { orgId, options = {} } = params; - const localVarPath = `/api/insights/v1/account/{org_id}/` - .replace(`{${"org_id"}}`, encodeURIComponent(String(orgId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - const localVarRequestOptions = { method: 'GET' as Method, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; - - return { - urlObj: localVarUrlObj, - options: localVarRequestOptions, - auth:[ - { - // authentication x-rh-identity required - // in header with key required - authType: AuthTypeEnum.InHeader, - authKey: "x-rh-identity" - } - ] - }; -} - -export default accountRetrieveParamCreator; diff --git a/packages/insights/PathwayCreate/index.ts b/packages/insights/PathwayCreate/index.ts deleted file mode 100644 index ce4455b3d..000000000 --- a/packages/insights/PathwayCreate/index.ts +++ /dev/null @@ -1,68 +0,0 @@ -// @ts-ignore -import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios'; -// @ts-ignore -import { COLLECTION_FORMATS, RequiredError, AuthTypeEnum, DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; -import type { RequestArgs } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; -// @ts-ignore -import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; -import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; - -// @ts-ignore -import type { PathwayInput } from '../types'; - - -export type PathwayCreateParams = { - /** - * - * @type { PathwayInput } - * @memberof PathwayCreateApi - */ - pathwayInput: PathwayInput, - options?: AxiosRequestConfig -} - -export type PathwayCreateReturnType = AxiosPromise; - -const isPathwayCreateObjectParams = (params: [PathwayCreateParams] | unknown[]): params is [PathwayCreateParams] => { - return params.length === 1 && Object.prototype.hasOwnProperty.call(params, 'pathwayInput') -} -/** -* This creates a new Pathway in the system. Required fields are \"name,\" \"description,\" \"component,\" \"resolution_risk,\" and \"publish_date.\" \"name\" is a slug field and used to identify and retrieve Pathways for detailed analysis. The slug for a Pathway is auto-generated by converting the \"name\" to lowercase and replacing all spaces with dashes. \"resolution_risk\" should be the \"name\" of the ResolutionRisk to associate with this Pathway, not the risk value. -* @summary Create a new Pathway in the system -* @param {PathwayCreateParams} config with all available params. -* @param {*} [options] Override http request option. -* @throws {RequiredError} -*/ -export const pathwayCreateParamCreator = async (...config: ([PathwayCreateParams] | [PathwayInput, AxiosRequestConfig])): Promise => { - const params = isPathwayCreateObjectParams(config) ? config[0] : ['pathwayInput', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as PathwayCreateParams; - const { pathwayInput, options = {} } = params; - const localVarPath = `/api/insights/v1/pathway/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - const localVarRequestOptions = { method: 'POST' as Method, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; - - return { - urlObj: localVarUrlObj, - options: localVarRequestOptions, - serializeData: pathwayInput, - auth:[ - { - // authentication x-rh-identity required - // in header with key required - authType: AuthTypeEnum.InHeader, - authKey: "x-rh-identity" - } - ] - }; -} - -export default pathwayCreateParamCreator; diff --git a/packages/insights/PathwayDestroy/index.ts b/packages/insights/PathwayDestroy/index.ts deleted file mode 100644 index f5b57913f..000000000 --- a/packages/insights/PathwayDestroy/index.ts +++ /dev/null @@ -1,66 +0,0 @@ -// @ts-ignore -import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios'; -// @ts-ignore -import { COLLECTION_FORMATS, RequiredError, AuthTypeEnum, DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; -import type { RequestArgs } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; -// @ts-ignore -import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; -import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; - -// @ts-ignore -import type { } from '../types'; - - -export type PathwayDestroyParams = { - /** - * - * @type { string } - * @memberof PathwayDestroyApi - */ - slug: string, - options?: AxiosRequestConfig -} - -export type PathwayDestroyReturnType = AxiosPromise; - -const isPathwayDestroyObjectParams = (params: [PathwayDestroyParams] | unknown[]): params is [PathwayDestroyParams] => { - return params.length === 1 && Object.prototype.hasOwnProperty.call(params, 'slug') -} -/** -* This will DELETE an existing Pathway in the system. Existing pathways are identified and deleted by the \"slug\" field. -* @summary Destroy an existing Pathway in the system -* @param {PathwayDestroyParams} config with all available params. -* @param {*} [options] Override http request option. -* @throws {RequiredError} -*/ -export const pathwayDestroyParamCreator = async (...config: ([PathwayDestroyParams] | [string, AxiosRequestConfig])): Promise => { - const params = isPathwayDestroyObjectParams(config) ? config[0] : ['slug', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as PathwayDestroyParams; - const { slug, options = {} } = params; - const localVarPath = `/api/insights/v1/pathway/{slug}/` - .replace(`{${"slug"}}`, encodeURIComponent(String(slug))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - const localVarRequestOptions = { method: 'DELETE' as Method, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; - - return { - urlObj: localVarUrlObj, - options: localVarRequestOptions, - auth:[ - { - // authentication x-rh-identity required - // in header with key required - authType: AuthTypeEnum.InHeader, - authKey: "x-rh-identity" - } - ] - }; -} - -export default pathwayDestroyParamCreator; diff --git a/packages/insights/PathwayUpdate/index.ts b/packages/insights/PathwayUpdate/index.ts deleted file mode 100644 index e60edb398..000000000 --- a/packages/insights/PathwayUpdate/index.ts +++ /dev/null @@ -1,75 +0,0 @@ -// @ts-ignore -import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios'; -// @ts-ignore -import { COLLECTION_FORMATS, RequiredError, AuthTypeEnum, DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; -import type { RequestArgs } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; -// @ts-ignore -import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; -import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; - -// @ts-ignore -import type { PathwayInput } from '../types'; - - -export type PathwayUpdateParams = { - /** - * - * @type { string } - * @memberof PathwayUpdateApi - */ - slug: string, - /** - * - * @type { PathwayInput } - * @memberof PathwayUpdateApi - */ - pathwayInput: PathwayInput, - options?: AxiosRequestConfig -} - -export type PathwayUpdateReturnType = AxiosPromise; - -const isPathwayUpdateObjectParams = (params: [PathwayUpdateParams] | unknown[]): params is [PathwayUpdateParams] => { - return params.length === 1 && Object.prototype.hasOwnProperty.call(params, 'slug') && Object.prototype.hasOwnProperty.call(params, 'pathwayInput') -} -/** -* This updates an existing Pathway already defined in the system. All fields that are required to define a Pathway initially may be updated here as well. Pathways are idenfitied and updated by the \"slug\" field. -* @summary Update an existing Pathway in the system -* @param {PathwayUpdateParams} config with all available params. -* @param {*} [options] Override http request option. -* @throws {RequiredError} -*/ -export const pathwayUpdateParamCreator = async (...config: ([PathwayUpdateParams] | [string, PathwayInput, AxiosRequestConfig])): Promise => { - const params = isPathwayUpdateObjectParams(config) ? config[0] : ['slug', 'pathwayInput', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as PathwayUpdateParams; - const { slug, pathwayInput, options = {} } = params; - const localVarPath = `/api/insights/v1/pathway/{slug}/` - .replace(`{${"slug"}}`, encodeURIComponent(String(slug))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - const localVarRequestOptions = { method: 'PUT' as Method, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; - - return { - urlObj: localVarUrlObj, - options: localVarRequestOptions, - serializeData: pathwayInput, - auth:[ - { - // authentication x-rh-identity required - // in header with key required - authType: AuthTypeEnum.InHeader, - authKey: "x-rh-identity" - } - ] - }; -} - -export default pathwayUpdateParamCreator; diff --git a/packages/insights/SettingsList/index.ts b/packages/insights/SettingsList/index.ts deleted file mode 100644 index d746dbadf..000000000 --- a/packages/insights/SettingsList/index.ts +++ /dev/null @@ -1,64 +0,0 @@ -// @ts-ignore -import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios'; -// @ts-ignore -import { COLLECTION_FORMATS, RequiredError, AuthTypeEnum, DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; -import type { RequestArgs } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; -// @ts-ignore -import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; -import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; - -// @ts-ignore -import type { SettingsDDF } from '../types'; - - -export type SettingsListParams = { - options?: AxiosRequestConfig -} - -export type SettingsListReturnType = Array; - -const isSettingsListObjectParams = (params: [SettingsListParams] | unknown[]): params is [SettingsListParams] => { - const l = params.length === 1 - if(l && typeof params[0] === 'object' && !Array.isArray(params[0])) { - return true - } - return false -} -/** -* Describe the settings we have in a Data-Driven Forms way. This simply compiles the \'show_satellite_hosts\' account-wide setting into a format compatible with Data-Driven Forms. -* @param {SettingsListParams} config with all available params. -* @param {*} [options] Override http request option. -* @throws {RequiredError} -*/ -export const settingsListParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([SettingsListParams] | [AxiosRequestConfig])) => { - const params = isSettingsListObjectParams(config) ? config[0] : ['options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as SettingsListParams; - const { options = {} } = params; - const localVarPath = `/api/insights/v1/settings/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - const localVarRequestOptions = { method: 'GET' as Method, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; - - const args = { - urlObj: localVarUrlObj, - options: localVarRequestOptions, - auth:[ - { - // authentication x-rh-identity required - // in header with key required - authType: AuthTypeEnum.InHeader, - authKey: "x-rh-identity" - } - ] - }; - - return sendRequest(Promise.resolve(args)); -} - -export default settingsListParamCreator; diff --git a/packages/insights/SystemRenderedReportsList/index.ts b/packages/insights/SystemRenderedReportsList/index.ts deleted file mode 100644 index 38963e2e0..000000000 --- a/packages/insights/SystemRenderedReportsList/index.ts +++ /dev/null @@ -1,134 +0,0 @@ -// @ts-ignore -import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios'; -// @ts-ignore -import { COLLECTION_FORMATS, RequiredError, AuthTypeEnum, DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; -import type { RequestArgs } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; -// @ts-ignore -import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; -import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; - -// @ts-ignore -import type { RenderedReport } from '../types'; - - -export type SystemRenderedReportsListParams = { - /** - * A UUID string identifying this inventory host. - * @type { string } - * @memberof SystemRenderedReportsListApi - */ - uuid: string, - /** - * Is this an Ansible system? - * @type { boolean } - * @memberof SystemRenderedReportsListApi - */ - filterSystemProfileAnsible?: boolean, - /** - * Is this a Microsoft SQL system? - * @type { boolean } - * @memberof SystemRenderedReportsListApi - */ - filterSystemProfileMssql?: boolean, - /** - * Are there systems which contain these SAP SIDs? - * @type { Array } - * @memberof SystemRenderedReportsListApi - */ - filterSystemProfileSapSidsContains?: Array, - /** - * Is this a SAP system? - * @type { boolean } - * @memberof SystemRenderedReportsListApi - */ - filterSystemProfileSapSystem?: boolean, - /** - * Tags have a namespace, key and value in the form namespace/key=value - * @type { Array } - * @memberof SystemRenderedReportsListApi - */ - tags?: Array, - /** - * Search for systems with this updater type - * @type { Array } - * @memberof SystemRenderedReportsListApi - */ - updateMethod?: Array, - options?: AxiosRequestConfig -} -/** - * @export - * @enum {string} - */ -export const SystemRenderedReportsListUpdateMethodEnum = { - Dnfyum: 'dnfyum', - Ostree: 'ostree' -} as const; -export type SystemRenderedReportsListUpdateMethodEnum = typeof SystemRenderedReportsListUpdateMethodEnum[keyof typeof SystemRenderedReportsListUpdateMethodEnum]; - -export type SystemRenderedReportsListReturnType = AxiosPromise>; - -const isSystemRenderedReportsListObjectParams = (params: [SystemRenderedReportsListParams] | unknown[]): params is [SystemRenderedReportsListParams] => { - return params.length === 1 && Object.prototype.hasOwnProperty.call(params, 'uuid') && true && true && true && true && true && true -} -/** -* Returns the list of reports for an Inventory Host ID, with the rule templates filled in thanks to node.js and DoT and Markdown. If the host ID is not found, return an empty list. -* @param {SystemRenderedReportsListParams} config with all available params. -* @param {*} [options] Override http request option. -* @throws {RequiredError} -*/ -export const systemRenderedReportsListParamCreator = async (...config: ([SystemRenderedReportsListParams] | [string, boolean, boolean, Array, boolean, Array, Array, AxiosRequestConfig])): Promise => { - const params = isSystemRenderedReportsListObjectParams(config) ? config[0] : ['uuid', 'filterSystemProfileAnsible', 'filterSystemProfileMssql', 'filterSystemProfileSapSidsContains', 'filterSystemProfileSapSystem', 'tags', 'updateMethod', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as SystemRenderedReportsListParams; - const { uuid, filterSystemProfileAnsible, filterSystemProfileMssql, filterSystemProfileSapSidsContains, filterSystemProfileSapSystem, tags, updateMethod, options = {} } = params; - const localVarPath = `/api/insights/v1/system/{uuid}/rendered_reports/` - .replace(`{${"uuid"}}`, encodeURIComponent(String(uuid))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - const localVarRequestOptions = { method: 'GET' as Method, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (filterSystemProfileAnsible !== undefined) { - localVarQueryParameter['filter[system_profile][ansible]'] = filterSystemProfileAnsible; - } - - if (filterSystemProfileMssql !== undefined) { - localVarQueryParameter['filter[system_profile][mssql]'] = filterSystemProfileMssql; - } - - if (filterSystemProfileSapSidsContains) { - localVarQueryParameter['filter[system_profile][sap_sids][contains]'] = filterSystemProfileSapSidsContains; - } - - if (filterSystemProfileSapSystem !== undefined) { - localVarQueryParameter['filter[system_profile][sap_system]'] = filterSystemProfileSapSystem; - } - - if (tags) { - localVarQueryParameter['tags'] = tags; - } - - if (updateMethod) { - localVarQueryParameter['update_method'] = updateMethod; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; - - return { - urlObj: localVarUrlObj, - options: localVarRequestOptions, - auth:[ - { - // authentication x-rh-identity required - // in header with key required - authType: AuthTypeEnum.InHeader, - authKey: "x-rh-identity" - } - ] - }; -} - -export default systemRenderedReportsListParamCreator; diff --git a/packages/insights/TopicCreate/index.ts b/packages/insights/TopicCreate/index.ts deleted file mode 100644 index 172bb703e..000000000 --- a/packages/insights/TopicCreate/index.ts +++ /dev/null @@ -1,74 +0,0 @@ -// @ts-ignore -import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios'; -// @ts-ignore -import { COLLECTION_FORMATS, RequiredError, AuthTypeEnum, DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; -import type { RequestArgs } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; -// @ts-ignore -import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; -import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; - -// @ts-ignore -import type { TopicEdit } from '../types'; - - -export type TopicCreateParams = { - /** - * - * @type { TopicEdit } - * @memberof TopicCreateApi - */ - topicEdit: TopicEdit, - options?: AxiosRequestConfig -} - -export type TopicCreateReturnType = TopicEdit; - -const isTopicCreateObjectParams = (params: [TopicCreateParams] | unknown[]): params is [TopicCreateParams] => { - const l = params.length === 1 - if(l && typeof params[0] === 'object' && !Array.isArray(params[0])) { - return true && Object.prototype.hasOwnProperty.call(params[0], 'topicEdit') - } - return false -} -/** -* Create a new rule topic, along with its association to a rule tag -* @summary Create a new rule topic -* @param {TopicCreateParams} config with all available params. -* @param {*} [options] Override http request option. -* @throws {RequiredError} -*/ -export const topicCreateParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([TopicCreateParams] | [TopicEdit, AxiosRequestConfig])) => { - const params = isTopicCreateObjectParams(config) ? config[0] : ['topicEdit', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as TopicCreateParams; - const { topicEdit, options = {} } = params; - const localVarPath = `/api/insights/v1/topic/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - const localVarRequestOptions = { method: 'POST' as Method, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; - - const args = { - urlObj: localVarUrlObj, - options: localVarRequestOptions, - serializeData: topicEdit, - auth:[ - { - // authentication x-rh-identity required - // in header with key required - authType: AuthTypeEnum.InHeader, - authKey: "x-rh-identity" - } - ] - }; - - return sendRequest(Promise.resolve(args)); -} - -export default topicCreateParamCreator; diff --git a/packages/insights/TopicDestroy/index.ts b/packages/insights/TopicDestroy/index.ts deleted file mode 100644 index 4b3bcc12f..000000000 --- a/packages/insights/TopicDestroy/index.ts +++ /dev/null @@ -1,72 +0,0 @@ -// @ts-ignore -import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios'; -// @ts-ignore -import { COLLECTION_FORMATS, RequiredError, AuthTypeEnum, DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; -import type { RequestArgs } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; -// @ts-ignore -import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; -import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; - -// @ts-ignore -import type { } from '../types'; - - -export type TopicDestroyParams = { - /** - * - * @type { string } - * @memberof TopicDestroyApi - */ - slug: string, - options?: AxiosRequestConfig -} - -export type TopicDestroyReturnType = void; - -const isTopicDestroyObjectParams = (params: [TopicDestroyParams] | unknown[]): params is [TopicDestroyParams] => { - const l = params.length === 1 - if(l && typeof params[0] === 'object' && !Array.isArray(params[0])) { - return true && Object.prototype.hasOwnProperty.call(params[0], 'slug') - } - return false -} -/** -* Delete a rule topic. Rules associated with the tag of this topic will be unaffected -* @summary Delete a rule topic -* @param {TopicDestroyParams} config with all available params. -* @param {*} [options] Override http request option. -* @throws {RequiredError} -*/ -export const topicDestroyParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([TopicDestroyParams] | [string, AxiosRequestConfig])) => { - const params = isTopicDestroyObjectParams(config) ? config[0] : ['slug', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as TopicDestroyParams; - const { slug, options = {} } = params; - const localVarPath = `/api/insights/v1/topic/{slug}/` - .replace(`{${"slug"}}`, encodeURIComponent(String(slug))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - const localVarRequestOptions = { method: 'DELETE' as Method, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; - - const args = { - urlObj: localVarUrlObj, - options: localVarRequestOptions, - auth:[ - { - // authentication x-rh-identity required - // in header with key required - authType: AuthTypeEnum.InHeader, - authKey: "x-rh-identity" - } - ] - }; - - return sendRequest(Promise.resolve(args)); -} - -export default topicDestroyParamCreator; diff --git a/packages/insights/TopicPartialUpdate/index.ts b/packages/insights/TopicPartialUpdate/index.ts deleted file mode 100644 index 943cb5f27..000000000 --- a/packages/insights/TopicPartialUpdate/index.ts +++ /dev/null @@ -1,81 +0,0 @@ -// @ts-ignore -import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios'; -// @ts-ignore -import { COLLECTION_FORMATS, RequiredError, AuthTypeEnum, DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; -import type { RequestArgs } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; -// @ts-ignore -import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; -import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; - -// @ts-ignore -import type { PatchedTopicEdit, TopicEdit } from '../types'; - - -export type TopicPartialUpdateParams = { - /** - * - * @type { string } - * @memberof TopicPartialUpdateApi - */ - slug: string, - /** - * - * @type { PatchedTopicEdit } - * @memberof TopicPartialUpdateApi - */ - patchedTopicEdit?: PatchedTopicEdit, - options?: AxiosRequestConfig -} - -export type TopicPartialUpdateReturnType = TopicEdit; - -const isTopicPartialUpdateObjectParams = (params: [TopicPartialUpdateParams] | unknown[]): params is [TopicPartialUpdateParams] => { - const l = params.length === 1 - if(l && typeof params[0] === 'object' && !Array.isArray(params[0])) { - return true && Object.prototype.hasOwnProperty.call(params[0], 'slug') - } - return false -} -/** -* Update an existing rule topic. Only the fields being changed need to be supplied -* @summary Partially update a rule topic -* @param {TopicPartialUpdateParams} config with all available params. -* @param {*} [options] Override http request option. -* @throws {RequiredError} -*/ -export const topicPartialUpdateParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([TopicPartialUpdateParams] | [string, PatchedTopicEdit, AxiosRequestConfig])) => { - const params = isTopicPartialUpdateObjectParams(config) ? config[0] : ['slug', 'patchedTopicEdit', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as TopicPartialUpdateParams; - const { slug, patchedTopicEdit, options = {} } = params; - const localVarPath = `/api/insights/v1/topic/{slug}/` - .replace(`{${"slug"}}`, encodeURIComponent(String(slug))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - const localVarRequestOptions = { method: 'PATCH' as Method, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; - - const args = { - urlObj: localVarUrlObj, - options: localVarRequestOptions, - serializeData: patchedTopicEdit, - auth:[ - { - // authentication x-rh-identity required - // in header with key required - authType: AuthTypeEnum.InHeader, - authKey: "x-rh-identity" - } - ] - }; - - return sendRequest(Promise.resolve(args)); -} - -export default topicPartialUpdateParamCreator; diff --git a/packages/insights/TopicUpdate/index.ts b/packages/insights/TopicUpdate/index.ts deleted file mode 100644 index b9c2a228a..000000000 --- a/packages/insights/TopicUpdate/index.ts +++ /dev/null @@ -1,81 +0,0 @@ -// @ts-ignore -import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios'; -// @ts-ignore -import { COLLECTION_FORMATS, RequiredError, AuthTypeEnum, DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; -import type { RequestArgs } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; -// @ts-ignore -import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; -import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; - -// @ts-ignore -import type { TopicEdit } from '../types'; - - -export type TopicUpdateParams = { - /** - * - * @type { string } - * @memberof TopicUpdateApi - */ - slug: string, - /** - * - * @type { TopicEdit } - * @memberof TopicUpdateApi - */ - topicEdit: TopicEdit, - options?: AxiosRequestConfig -} - -export type TopicUpdateReturnType = TopicEdit; - -const isTopicUpdateObjectParams = (params: [TopicUpdateParams] | unknown[]): params is [TopicUpdateParams] => { - const l = params.length === 1 - if(l && typeof params[0] === 'object' && !Array.isArray(params[0])) { - return true && Object.prototype.hasOwnProperty.call(params[0], 'slug') && Object.prototype.hasOwnProperty.call(params[0], 'topicEdit') - } - return false -} -/** -* Update an existing rule topic. All fields need to be supplied -* @summary Update a rule topic -* @param {TopicUpdateParams} config with all available params. -* @param {*} [options] Override http request option. -* @throws {RequiredError} -*/ -export const topicUpdateParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([TopicUpdateParams] | [string, TopicEdit, AxiosRequestConfig])) => { - const params = isTopicUpdateObjectParams(config) ? config[0] : ['slug', 'topicEdit', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as TopicUpdateParams; - const { slug, topicEdit, options = {} } = params; - const localVarPath = `/api/insights/v1/topic/{slug}/` - .replace(`{${"slug"}}`, encodeURIComponent(String(slug))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - const localVarRequestOptions = { method: 'PUT' as Method, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; - - const args = { - urlObj: localVarUrlObj, - options: localVarRequestOptions, - serializeData: topicEdit, - auth:[ - { - // authentication x-rh-identity required - // in header with key required - authType: AuthTypeEnum.InHeader, - authKey: "x-rh-identity" - } - ] - }; - - return sendRequest(Promise.resolve(args)); -} - -export default topicUpdateParamCreator; diff --git a/packages/insights/UsageList/index.ts b/packages/insights/UsageList/index.ts deleted file mode 100644 index cca6bc1df..000000000 --- a/packages/insights/UsageList/index.ts +++ /dev/null @@ -1,102 +0,0 @@ -// @ts-ignore -import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios'; -// @ts-ignore -import { COLLECTION_FORMATS, RequiredError, AuthTypeEnum, DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; -import type { RequestArgs } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; -// @ts-ignore -import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; -import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; - -// @ts-ignore -import type { Usage } from '../types'; - - -export type UsageListParams = { - /** - * Allow `hydrauser` to view any account - * @type { Array } - * @memberof UsageListApi - */ - account?: Array, - /** - * End date for statistics range - * @type { string } - * @memberof UsageListApi - */ - end?: string, - /** - * Allow `hydrauser` to view any org_id - * @type { string } - * @memberof UsageListApi - */ - orgId?: string, - /** - * Start date for statistics range - * @type { string } - * @memberof UsageListApi - */ - start?: string, - options?: AxiosRequestConfig -} - -export type UsageListReturnType = AxiosPromise; - -const isUsageListObjectParams = (params: [UsageListParams] | unknown[]): params is [UsageListParams] => { - return params.length === 1 && true && true && true && true -} -/** -* List the unique rule hits for this account over the given time range This uses a HashLogLog structure to record number of hits, and this is therefore an approximation. -* @param {UsageListParams} config with all available params. -* @param {*} [options] Override http request option. -* @throws {RequiredError} -*/ -export const usageListParamCreator = async (...config: ([UsageListParams] | [Array, string, string, string, AxiosRequestConfig])): Promise => { - const params = isUsageListObjectParams(config) ? config[0] : ['account', 'end', 'orgId', 'start', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as UsageListParams; - const { account, end, orgId, start, options = {} } = params; - const localVarPath = `/api/insights/v1/usage/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - const localVarRequestOptions = { method: 'GET' as Method, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (account) { - localVarQueryParameter['account'] = account; - } - - if (end !== undefined) { - localVarQueryParameter['end'] = (end as any instanceof Date) ? - (end as any).toISOString().substr(0,10) : - end; - } - - if (orgId !== undefined) { - localVarQueryParameter['org_id'] = orgId; - } - - if (start !== undefined) { - localVarQueryParameter['start'] = (start as any instanceof Date) ? - (start as any).toISOString().substr(0,10) : - start; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; - - return { - urlObj: localVarUrlObj, - options: localVarRequestOptions, - auth:[ - { - // authentication x-rh-identity required - // in header with key required - authType: AuthTypeEnum.InHeader, - authKey: "x-rh-identity" - } - ] - }; -} - -export default usageListParamCreator; diff --git a/packages/insights/custom.d.ts b/packages/insights/custom.d.ts deleted file mode 100644 index 32534cb16..000000000 --- a/packages/insights/custom.d.ts +++ /dev/null @@ -1 +0,0 @@ -declare module 'url'; \ No newline at end of file diff --git a/packages/insights/doc/.nojekyll b/packages/insights/doc/.nojekyll deleted file mode 100644 index e2ac6616a..000000000 --- a/packages/insights/doc/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/packages/insights/doc/README.md b/packages/insights/doc/README.md deleted file mode 100644 index 69ab6a057..000000000 --- a/packages/insights/doc/README.md +++ /dev/null @@ -1,69 +0,0 @@ -@redhat-cloud-services/insights-client / [Exports](modules.md) - -# Javascript client for Insights API -If you want to use [RedHatInsights/insights-advisor-api](https://github.com/RedHatInsights/insights-advisor-api) you shouldn't use get requests directly, but rather use this client to integrate with this service. - -## Install -NPM -```bash -npm install --save @redhat-cloud-services/insights-client -``` - -Or Yarn -```bash -yarn add @redhat-cloud-services/insights-client -``` - -### Usage -This client is using typescript and axios. Types are distributed with this package, so no need to define or install them separately. - -To correctly bootstrap this API you should use this config (no need to define it multiple times, just one config and reimport it anywhere you want to use it). -```JS -// api.js -import axios from 'axios'; -import { GroupApi } from '@redhat-cloud-services/insights-client'; -const instance = axios.create(); - -// BASE_PATH should be set in your constants file -const groupApi = new GroupApi(undefined, BASE_PATH, instance); -export groupApi; -``` - -If you want to add some interceptors you can use axios build in interceptors -```JS -// api.js -import axios from 'axios'; -import { SystemApi } from '@redhat-cloud-services/insights-client'; -const instance = axios.create(); - -// Request interceptor -instance.interceptors.request.use((request) => { - // some logic to do with request -}); - -// Response interceptor -instance.interceptors.response.use((response) => { - // some logic to do with request -}); - -// Error interceptor -instance.interceptors.response.use(null, (error) => { - // some logic to do with error -}); - -// BASE_PATH should be set in your constants file -const systemApi = new SystemApi(undefined, BASE_PATH, instance); -export systemApi; -``` - -## Building - -Run `nx build @redhat-cloud-services/insights-client` to build the library. - -## Running unit tests - -Run `nx test @redhat-cloud-services/insights-client` to execute the unit tests via [Jest](https://jestjs.io). - -## API documentation - -* [README](doc/README.md) diff --git a/packages/insights/doc/classes/AccountApi.md b/packages/insights/doc/classes/AccountApi.md deleted file mode 100644 index 1b1880dcb..000000000 --- a/packages/insights/doc/classes/AccountApi.md +++ /dev/null @@ -1,189 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / AccountApi - -# Class: AccountApi - -AccountApi - object-oriented interface - -**`Export`** - -AccountApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`AccountApi`** - -## Table of contents - -### Constructors - -- [constructor](AccountApi.md#constructor) - -### Properties - -- [axios](AccountApi.md#axios) -- [basePath](AccountApi.md#basepath) -- [configuration](AccountApi.md#configuration) - -### Methods - -- [accountHostsRetrieve](AccountApi.md#accounthostsretrieve) -- [accountList](AccountApi.md#accountlist) -- [accountRetrieve](AccountApi.md#accountretrieve) - -## Constructors - -### constructor - -• **new AccountApi**(`configuration?`, `basePath?`, `axios?`): [`AccountApi`](AccountApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`AccountApi`](AccountApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L49) - -## Methods - -### accountHostsRetrieve - -▸ **accountHostsRetrieve**(`orgId`, `options?`): `Promise`\<`AxiosResponse`\<[`OrgId`](../interfaces/OrgId.md), `any`\>\> - -List details about the number of hosts in this account by org_id. As well as the total number of hosts, we report on the number of hosts in various states of staleness: * fresh: hosts that have updated in the last 26 hours * stale: hosts not updated in the last 26 hours - we display the results for these hosts but a warning is shown to say they are not updating * warn: hosts not updated in the last week - these are not shown in any queries This may have other aggregate data added in the future. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `orgId` | `string` | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`OrgId`](../interfaces/OrgId.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -AccountApi - -#### Defined in - -[api.ts:2564](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2564) - -___ - -### accountList - -▸ **accountList**(`limit?`, `offset?`, `options?`): `Promise`\<`AxiosResponse`\<[`PaginatedOrgIdList`](../interfaces/PaginatedOrgIdList.md), `any`\>\> - -List all accounts by org_id we know about (through the host table). No other information about the accounts is provided in this view. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `limit?` | `number` | Number of results to return per page. | -| `offset?` | `number` | The initial index from which to return the results. | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`PaginatedOrgIdList`](../interfaces/PaginatedOrgIdList.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -AccountApi - -#### Defined in - -[api.ts:2576](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2576) - -___ - -### accountRetrieve - -▸ **accountRetrieve**(`orgId`, `options?`): `Promise`\<`AxiosResponse`\<[`OrgId`](../interfaces/OrgId.md), `any`\>\> - -List information relating to other accounts. This allows us to collect data that requires the user to specify an org_id number, such as number of systems currently registered to that org. param: org_id: Org ID number of a Red Hat customer. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `orgId` | `string` | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`OrgId`](../interfaces/OrgId.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -AccountApi - -#### Defined in - -[api.ts:2587](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2587) diff --git a/packages/insights/doc/classes/AckApi.md b/packages/insights/doc/classes/AckApi.md deleted file mode 100644 index 038ff4ae7..000000000 --- a/packages/insights/doc/classes/AckApi.md +++ /dev/null @@ -1,279 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / AckApi - -# Class: AckApi - -AckApi - object-oriented interface - -**`Export`** - -AckApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`AckApi`** - -## Table of contents - -### Constructors - -- [constructor](AckApi.md#constructor) - -### Properties - -- [axios](AckApi.md#axios) -- [basePath](AckApi.md#basepath) -- [configuration](AckApi.md#configuration) - -### Methods - -- [ackAllList](AckApi.md#ackalllist) -- [ackCreate](AckApi.md#ackcreate) -- [ackDestroy](AckApi.md#ackdestroy) -- [ackList](AckApi.md#acklist) -- [ackRetrieve](AckApi.md#ackretrieve) -- [ackUpdate](AckApi.md#ackupdate) - -## Constructors - -### constructor - -• **new AckApi**(`configuration?`, `basePath?`, `axios?`): [`AckApi`](AckApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`AckApi`](AckApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L49) - -## Methods - -### ackAllList - -▸ **ackAllList**(`options?`): `Promise`\<`AxiosResponse`\<[`AllAck`](../interfaces/AllAck.md)[], `any`\>\> - -List acks from all accounts, with org_id. Has no pagination. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`AllAck`](../interfaces/AllAck.md)[], `any`\>\> - -**`Throws`** - -**`Memberof`** - -AckApi - -#### Defined in - -[api.ts:3032](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L3032) - -___ - -### ackCreate - -▸ **ackCreate**(`ackInput`, `options?`): `Promise`\<`AxiosResponse`\<[`Ack`](../interfaces/Ack.md), `any`\>\> - -Add an acknowledgement for a rule, by rule ID. If there\'s already an acknowledgement of this rule by this accounts org_id, then return that. Otherwise, a new ack is created. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `ackInput` | [`AckInput`](../interfaces/AckInput.md) | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`Ack`](../interfaces/Ack.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -AckApi - -#### Defined in - -[api.ts:3043](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L3043) - -___ - -### ackDestroy - -▸ **ackDestroy**(`ruleId`, `options?`): `Promise`\<`AxiosResponse`\<`string`, `any`\>\> - -Delete an acknowledgement for a rule, by its rule ID. If the ack existed, it is deleted and a 204 is returned. Otherwise, a 404 is returned. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `ruleId` | `string` | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`string`, `any`\>\> - -**`Throws`** - -**`Memberof`** - -AckApi - -#### Defined in - -[api.ts:3054](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L3054) - -___ - -### ackList - -▸ **ackList**(`limit?`, `offset?`, `options?`): `Promise`\<`AxiosResponse`\<[`PaginatedAckList`](../interfaces/PaginatedAckList.md), `any`\>\> - -List acks from this account by org_id where the rule is active Will return an empty list if this account has no acks. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `limit?` | `number` | Number of results to return per page. | -| `offset?` | `number` | The initial index from which to return the results. | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`PaginatedAckList`](../interfaces/PaginatedAckList.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -AckApi - -#### Defined in - -[api.ts:3066](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L3066) - -___ - -### ackRetrieve - -▸ **ackRetrieve**(`ruleId`, `options?`): `Promise`\<`AxiosResponse`\<[`Ack`](../interfaces/Ack.md), `any`\>\> - -Acks acknowledge (and therefore hide) a rule from view in an account. This view handles listing, retrieving, creating and deleting acks. Acks are created and deleted by Insights rule ID, not by their own ack ID. param: rule_id: Rule ID defined by Insights ruleset - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `ruleId` | `string` | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`Ack`](../interfaces/Ack.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -AckApi - -#### Defined in - -[api.ts:3077](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L3077) - -___ - -### ackUpdate - -▸ **ackUpdate**(`ruleId`, `ackJustification?`, `options?`): `Promise`\<`AxiosResponse`\<[`Ack`](../interfaces/Ack.md), `any`\>\> - -Update an acknowledgement for a rule, by rule ID. A new justification can be supplied. The username is taken from the authenticated request. The updated ack is returned. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `ruleId` | `string` | | -| `ackJustification?` | [`AckJustification`](../interfaces/AckJustification.md) | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`Ack`](../interfaces/Ack.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -AckApi - -#### Defined in - -[api.ts:3089](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L3089) diff --git a/packages/insights/doc/classes/AckcountApi.md b/packages/insights/doc/classes/AckcountApi.md deleted file mode 100644 index 7620cc04f..000000000 --- a/packages/insights/doc/classes/AckcountApi.md +++ /dev/null @@ -1,157 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / AckcountApi - -# Class: AckcountApi - -AckcountApi - object-oriented interface - -**`Export`** - -AckcountApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`AckcountApi`** - -## Table of contents - -### Constructors - -- [constructor](AckcountApi.md#constructor) - -### Properties - -- [axios](AckcountApi.md#axios) -- [basePath](AckcountApi.md#basepath) -- [configuration](AckcountApi.md#configuration) - -### Methods - -- [ackcountList](AckcountApi.md#ackcountlist) -- [ackcountRetrieve](AckcountApi.md#ackcountretrieve) - -## Constructors - -### constructor - -• **new AckcountApi**(`configuration?`, `basePath?`, `axios?`): [`AckcountApi`](AckcountApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`AckcountApi`](AckcountApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L49) - -## Methods - -### ackcountList - -▸ **ackcountList**(`options?`): `Promise`\<`AxiosResponse`\<[`AckCount`](../interfaces/AckCount.md)[], `any`\>\> - -Get the ack counts for all active rules Return a list of rule_ids and their ack counts - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`AckCount`](../interfaces/AckCount.md)[], `any`\>\> - -**`Throws`** - -**`Memberof`** - -AckcountApi - -#### Defined in - -[api.ts:3258](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L3258) - -___ - -### ackcountRetrieve - -▸ **ackcountRetrieve**(`ruleId`, `options?`): `Promise`\<`AxiosResponse`\<[`AckCount`](../interfaces/AckCount.md), `any`\>\> - -Get the ack count for the given rule_id Returns the rule_id and its ack count - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `ruleId` | `string` | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`AckCount`](../interfaces/AckCount.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -AckcountApi - -#### Defined in - -[api.ts:3269](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L3269) diff --git a/packages/insights/doc/classes/AutosubexclusionApi.md b/packages/insights/doc/classes/AutosubexclusionApi.md deleted file mode 100644 index 7abd244b0..000000000 --- a/packages/insights/doc/classes/AutosubexclusionApi.md +++ /dev/null @@ -1,219 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / AutosubexclusionApi - -# Class: AutosubexclusionApi - -AutosubexclusionApi - object-oriented interface - -**`Export`** - -AutosubexclusionApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`AutosubexclusionApi`** - -## Table of contents - -### Constructors - -- [constructor](AutosubexclusionApi.md#constructor) - -### Properties - -- [axios](AutosubexclusionApi.md#axios) -- [basePath](AutosubexclusionApi.md#basepath) -- [configuration](AutosubexclusionApi.md#configuration) - -### Methods - -- [autosubexclusionCreate](AutosubexclusionApi.md#autosubexclusioncreate) -- [autosubexclusionDestroy](AutosubexclusionApi.md#autosubexclusiondestroy) -- [autosubexclusionList](AutosubexclusionApi.md#autosubexclusionlist) -- [autosubexclusionRetrieve](AutosubexclusionApi.md#autosubexclusionretrieve) - -## Constructors - -### constructor - -• **new AutosubexclusionApi**(`configuration?`, `basePath?`, `axios?`): [`AutosubexclusionApi`](AutosubexclusionApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`AutosubexclusionApi`](AutosubexclusionApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L49) - -## Methods - -### autosubexclusionCreate - -▸ **autosubexclusionCreate**(`subscriptionExcludedAccount`, `options?`): `Promise`\<`AxiosResponse`\<[`SubscriptionExcludedAccount`](../interfaces/SubscriptionExcludedAccount.md), `any`\>\> - -Create a new subscription exclusion for an account. This creates a new subscription exclusion for an account. This should contain an org_id and account. Only org_id is required. Account is optional. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `subscriptionExcludedAccount` | [`SubscriptionExcludedAccount`](../interfaces/SubscriptionExcludedAccount.md) | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`SubscriptionExcludedAccount`](../interfaces/SubscriptionExcludedAccount.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -AutosubexclusionApi - -#### Defined in - -[api.ts:3586](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L3586) - -___ - -### autosubexclusionDestroy - -▸ **autosubexclusionDestroy**(`orgId`, `options?`): `Promise`\<`AxiosResponse`\<`string`, `any`\>\> - -Destroy an existing subscription exclusion in the system. This will DELETE an existing subscription exclusion in the system. Existing subscription exclusions are identified and deleted by the \"org_id\" field. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `orgId` | `string` | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`string`, `any`\>\> - -**`Throws`** - -**`Memberof`** - -AutosubexclusionApi - -#### Defined in - -[api.ts:3597](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L3597) - -___ - -### autosubexclusionList - -▸ **autosubexclusionList**(`limit?`, `offset?`, `options?`): `Promise`\<`AxiosResponse`\<[`PaginatedSubscriptionExcludedAccountList`](../interfaces/PaginatedSubscriptionExcludedAccountList.md), `any`\>\> - -Returns all subscription exclusions for accounts This returns a list of all subscription exclusions. This contains exclusions and their account and org_id. These are all accounts that are excluded from the autosub subscription path for weekly report subscriptions. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `limit?` | `number` | Number of results to return per page. | -| `offset?` | `number` | The initial index from which to return the results. | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`PaginatedSubscriptionExcludedAccountList`](../interfaces/PaginatedSubscriptionExcludedAccountList.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -AutosubexclusionApi - -#### Defined in - -[api.ts:3609](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L3609) - -___ - -### autosubexclusionRetrieve - -▸ **autosubexclusionRetrieve**(`orgId`, `options?`): `Promise`\<`AxiosResponse`\<[`SubscriptionExcludedAccount`](../interfaces/SubscriptionExcludedAccount.md), `any`\>\> - -Returns an individual subscription exclusion based on org_id. This returns an individual subscription exclusion based on the org_id. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `orgId` | `string` | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`SubscriptionExcludedAccount`](../interfaces/SubscriptionExcludedAccount.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -AutosubexclusionApi - -#### Defined in - -[api.ts:3620](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L3620) diff --git a/packages/insights/doc/classes/Configuration.md b/packages/insights/doc/classes/Configuration.md deleted file mode 100644 index 4a0e491aa..000000000 --- a/packages/insights/doc/classes/Configuration.md +++ /dev/null @@ -1,146 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / Configuration - -# Class: Configuration - -## Table of contents - -### Constructors - -- [constructor](Configuration.md#constructor) - -### Properties - -- [accessToken](Configuration.md#accesstoken) -- [apiKey](Configuration.md#apikey) -- [baseOptions](Configuration.md#baseoptions) -- [basePath](Configuration.md#basepath) -- [password](Configuration.md#password) -- [username](Configuration.md#username) - -## Constructors - -### constructor - -• **new Configuration**(`param?`): [`Configuration`](Configuration.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `param` | [`ConfigurationParameters`](../interfaces/ConfigurationParameters.md) | - -#### Returns - -[`Configuration`](Configuration.md) - -#### Defined in - -[configuration.ts:67](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/configuration.ts#L67) - -## Properties - -### accessToken - -• `Optional` **accessToken**: `string` \| (`name?`: `string`, `scopes?`: `string`[]) => `string` - -parameter for oauth2 security - -**`Param`** - -security name - -**`Param`** - -oauth2 scope - -**`Memberof`** - -Configuration - -#### Defined in - -[configuration.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/configuration.ts#L51) - -___ - -### apiKey - -• `Optional` **apiKey**: `string` \| `Promise`\<`string`\> \| (`name`: `string`) => `string` \| (`name`: `string`) => `Promise`\<`string`\> - -parameter for apiKey security - -**`Param`** - -security name - -**`Memberof`** - -Configuration - -#### Defined in - -[configuration.ts:30](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/configuration.ts#L30) - -___ - -### baseOptions - -• `Optional` **baseOptions**: `any` - -base options for axios calls - -**`Memberof`** - -Configuration - -#### Defined in - -[configuration.ts:65](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/configuration.ts#L65) - -___ - -### basePath - -• `Optional` **basePath**: `string` - -override base path - -**`Memberof`** - -Configuration - -#### Defined in - -[configuration.ts:58](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/configuration.ts#L58) - -___ - -### password - -• `Optional` **password**: `string` - -parameter for basic security - -**`Memberof`** - -Configuration - -#### Defined in - -[configuration.ts:44](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/configuration.ts#L44) - -___ - -### username - -• `Optional` **username**: `string` - -parameter for basic security - -**`Memberof`** - -Configuration - -#### Defined in - -[configuration.ts:37](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/configuration.ts#L37) diff --git a/packages/insights/doc/classes/ExportApi.md b/packages/insights/doc/classes/ExportApi.md deleted file mode 100644 index 139913cbf..000000000 --- a/packages/insights/doc/classes/ExportApi.md +++ /dev/null @@ -1,269 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / ExportApi - -# Class: ExportApi - -ExportApi - object-oriented interface - -**`Export`** - -ExportApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`ExportApi`** - -## Table of contents - -### Constructors - -- [constructor](ExportApi.md#constructor) - -### Properties - -- [axios](ExportApi.md#axios) -- [basePath](ExportApi.md#basepath) -- [configuration](ExportApi.md#configuration) - -### Methods - -- [exportHitsList](ExportApi.md#exporthitslist) -- [exportReportsList](ExportApi.md#exportreportslist) -- [exportRulesList](ExportApi.md#exportruleslist) -- [exportSystemsList](ExportApi.md#exportsystemslist) - -## Constructors - -### constructor - -• **new ExportApi**(`configuration?`, `basePath?`, `axios?`): [`ExportApi`](ExportApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`ExportApi`](ExportApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L49) - -## Methods - -### exportHitsList - -▸ **exportHitsList**(`category?`, `displayName?`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `format?`, `groups?`, `hasPlaybook?`, `impact?`, `incident?`, `likelihood?`, `reboot?`, `resRisk?`, `tags?`, `text?`, `totalRisk?`, `updateMethod?`, `uuid?`, `options?`): `Promise`\<`AxiosResponse`\<[`ExportHits`](../interfaces/ExportHits.md)[], `any`\>\> - -Get each host and all rules currently affecting it. We also only present active, non-acked (on an account AND host level) rules. Inventory data may be requested if Advisor has not seen all the hosts. The accepted content type supplied in the request headers is used to determine the supplied content type. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `category?` | (``1`` \| ``2`` \| ``3`` \| ``4``)[] | Display rules of this category (number) | -| `displayName?` | `string` | Display systems with this text in their display_name | -| `filterSystemProfileSapSidsContains?` | `string`[] | Are there systems which contain these SAP SIDs? | -| `filterSystemProfileSapSystem?` | `boolean` | Is this a SAP system? | -| `format?` | ``"csv"`` \| ``"json"`` | | -| `groups?` | `string`[] | List of Inventory host group names | -| `hasPlaybook?` | `boolean` | Display rules that have a playbook | -| `impact?` | (``1`` \| ``2`` \| ``3`` \| ``4``)[] | Display rules of this impact level (1..4) | -| `incident?` | `boolean` | Display only rules that cause an incident | -| `likelihood?` | (``1`` \| ``2`` \| ``3`` \| ``4``)[] | Display only rules of this likelihood level (1..4) | -| `reboot?` | `boolean` | Display rules that require a reboot to fix | -| `resRisk?` | (``1`` \| ``2`` \| ``3`` \| ``4``)[] | Display rules with this resolution risk level (1..4) | -| `tags?` | `string`[] | Tags have a namespace, key and value in the form namespace/key=value | -| `text?` | `string` | Display rules with this text in their text fields | -| `totalRisk?` | (``1`` \| ``2`` \| ``3`` \| ``4``)[] | Display rules with this total risk level (1..4) | -| `updateMethod?` | (``"dnfyum"`` \| ``"ostree"``)[] | Search for systems with this updater type | -| `uuid?` | `string` | Display a system with this uuid | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`ExportHits`](../interfaces/ExportHits.md)[], `any`\>\> - -**`Throws`** - -**`Memberof`** - -ExportApi - -#### Defined in - -[api.ts:4297](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L4297) - -___ - -### exportReportsList - -▸ **exportReportsList**(`category?`, `displayName?`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `hasPlaybook?`, `impact?`, `incident?`, `likelihood?`, `reboot?`, `resRisk?`, `tags?`, `text?`, `totalRisk?`, `updateMethod?`, `uuid?`, `options?`): `Promise`\<`AxiosResponse`\<[`ReportExport`](../interfaces/ReportExport.md)[], `any`\>\> - -List the report details of each rule affecting each system. System and Rule are referred to by ID only, to be correlated with the Rule and System export data. It\'s like the hits output but much less repetitive. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `category?` | (``1`` \| ``2`` \| ``3`` \| ``4``)[] | Display rules of this category (number) | -| `displayName?` | `string` | Display systems with this text in their display_name | -| `filterSystemProfileSapSidsContains?` | `string`[] | Are there systems which contain these SAP SIDs? | -| `filterSystemProfileSapSystem?` | `boolean` | Is this a SAP system? | -| `groups?` | `string`[] | List of Inventory host group names | -| `hasPlaybook?` | `boolean` | Display rules that have a playbook | -| `impact?` | (``1`` \| ``2`` \| ``3`` \| ``4``)[] | Display rules of this impact level (1..4) | -| `incident?` | `boolean` | Display only rules that cause an incident | -| `likelihood?` | (``1`` \| ``2`` \| ``3`` \| ``4``)[] | Display only rules of this likelihood level (1..4) | -| `reboot?` | `boolean` | Display rules that require a reboot to fix | -| `resRisk?` | (``1`` \| ``2`` \| ``3`` \| ``4``)[] | Display rules with this resolution risk level (1..4) | -| `tags?` | `string`[] | Tags have a namespace, key and value in the form namespace/key=value | -| `text?` | `string` | Display rules with this text in their text fields | -| `totalRisk?` | (``1`` \| ``2`` \| ``3`` \| ``4``)[] | Display rules with this total risk level (1..4) | -| `updateMethod?` | (``"dnfyum"`` \| ``"ostree"``)[] | Search for systems with this updater type | -| `uuid?` | `string` | Display a system with this uuid | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`ReportExport`](../interfaces/ReportExport.md)[], `any`\>\> - -**`Throws`** - -**`Memberof`** - -ExportApi - -#### Defined in - -[api.ts:4323](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L4323) - -___ - -### exportRulesList - -▸ **exportRulesList**(`category?`, `displayName?`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `hasPlaybook?`, `impact?`, `incident?`, `likelihood?`, `reboot?`, `resRisk?`, `tags?`, `text?`, `totalRisk?`, `updateMethod?`, `uuid?`, `options?`): `Promise`\<`AxiosResponse`\<[`RuleExport`](../interfaces/RuleExport.md)[], `any`\>\> - -List the report details of each rule affecting each system. System and Rule are referred to by ID only, to be correlated with the Rule and System export data. It\'s like the hits output but much less repetitive. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `category?` | (``1`` \| ``2`` \| ``3`` \| ``4``)[] | Display rules of this category (number) | -| `displayName?` | `string` | Display systems with this text in their display_name | -| `filterSystemProfileSapSidsContains?` | `string`[] | Are there systems which contain these SAP SIDs? | -| `filterSystemProfileSapSystem?` | `boolean` | Is this a SAP system? | -| `groups?` | `string`[] | List of Inventory host group names | -| `hasPlaybook?` | `boolean` | Display rules that have a playbook | -| `impact?` | (``1`` \| ``2`` \| ``3`` \| ``4``)[] | Display rules of this impact level (1..4) | -| `incident?` | `boolean` | Display only rules that cause an incident | -| `likelihood?` | (``1`` \| ``2`` \| ``3`` \| ``4``)[] | Display only rules of this likelihood level (1..4) | -| `reboot?` | `boolean` | Display rules that require a reboot to fix | -| `resRisk?` | (``1`` \| ``2`` \| ``3`` \| ``4``)[] | Display rules with this resolution risk level (1..4) | -| `tags?` | `string`[] | Tags have a namespace, key and value in the form namespace/key=value | -| `text?` | `string` | Display rules with this text in their text fields | -| `totalRisk?` | (``1`` \| ``2`` \| ``3`` \| ``4``)[] | Display rules with this total risk level (1..4) | -| `updateMethod?` | (``"dnfyum"`` \| ``"ostree"``)[] | Search for systems with this updater type | -| `uuid?` | `string` | Display a system with this uuid | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`RuleExport`](../interfaces/RuleExport.md)[], `any`\>\> - -**`Throws`** - -**`Memberof`** - -ExportApi - -#### Defined in - -[api.ts:4349](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L4349) - -___ - -### exportSystemsList - -▸ **exportSystemsList**(`displayName?`, `format?`, `groups?`, `ruleId?`, `sort?`, `updateMethod?`, `options?`): `Promise`\<`AxiosResponse`\<[`System`](../interfaces/System.md)[], `any`\>\> - -List of systems with details and hit counts. Systems can be sorted and filtered by display name and rule id. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `displayName?` | `string` | Display systems with this text in their display_name | -| `format?` | ``"csv"`` \| ``"json"`` | | -| `groups?` | `string`[] | List of Inventory host group names | -| `ruleId?` | `string` | Display systems with this text in their rule_id | -| `sort?` | ``"-critical_hits"`` \| ``"-display_name"`` \| ``"-group_name"`` \| ``"-hits"`` \| ``"-important_hits"`` \| ``"-last_seen"`` \| ``"-low_hits"`` \| ``"-moderate_hits"`` \| ``"-rhel_version"`` \| ``"critical_hits"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"hits"`` \| ``"important_hits"`` \| ``"last_seen"`` \| ``"low_hits"`` \| ``"moderate_hits"`` \| ``"rhel_version"`` | Order by this field | -| `updateMethod?` | (``"dnfyum"`` \| ``"ostree"``)[] | Search for systems with this updater type | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`System`](../interfaces/System.md)[], `any`\>\> - -**`Throws`** - -**`Memberof`** - -ExportApi - -#### Defined in - -[api.ts:4365](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L4365) diff --git a/packages/insights/doc/classes/HostackApi.md b/packages/insights/doc/classes/HostackApi.md deleted file mode 100644 index 54e3d4324..000000000 --- a/packages/insights/doc/classes/HostackApi.md +++ /dev/null @@ -1,255 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / HostackApi - -# Class: HostackApi - -HostackApi - object-oriented interface - -**`Export`** - -HostackApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`HostackApi`** - -## Table of contents - -### Constructors - -- [constructor](HostackApi.md#constructor) - -### Properties - -- [axios](HostackApi.md#axios) -- [basePath](HostackApi.md#basepath) -- [configuration](HostackApi.md#configuration) - -### Methods - -- [hostackCreate](HostackApi.md#hostackcreate) -- [hostackDestroy](HostackApi.md#hostackdestroy) -- [hostackList](HostackApi.md#hostacklist) -- [hostackRetrieve](HostackApi.md#hostackretrieve) -- [hostackUpdate](HostackApi.md#hostackupdate) - -## Constructors - -### constructor - -• **new HostackApi**(`configuration?`, `basePath?`, `axios?`): [`HostackApi`](HostackApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`HostackApi`](HostackApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L49) - -## Methods - -### hostackCreate - -▸ **hostackCreate**(`hostAckInput`, `options?`): `Promise`\<`AxiosResponse`\<[`HostAck`](../interfaces/HostAck.md), `any`\>\> - -Add an acknowledgement for a rule, by rule ID, system, and account. Return the new hostack. If there\'s already an acknowledgement of this rule by this account for a system, then return that. This does not take an \'id\' number. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `hostAckInput` | [`HostAckInput`](../interfaces/HostAckInput.md) | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`HostAck`](../interfaces/HostAck.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -HostackApi - -#### Defined in - -[api.ts:4789](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L4789) - -___ - -### hostackDestroy - -▸ **hostackDestroy**(`id`, `options?`): `Promise`\<`AxiosResponse`\<`string`, `any`\>\> - -Delete an acknowledgement for a rule, for a system, for an account, by its ID. Takes the hostack ID (given in the hostack list) as an identifier. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `number` | A unique integer value identifying this host ack. | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`string`, `any`\>\> - -**`Throws`** - -**`Memberof`** - -HostackApi - -#### Defined in - -[api.ts:4800](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L4800) - -___ - -### hostackList - -▸ **hostackList**(`filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `limit?`, `offset?`, `ruleId?`, `tags?`, `options?`): `Promise`\<`AxiosResponse`\<[`PaginatedHostAckList`](../interfaces/PaginatedHostAckList.md), `any`\>\> - -List host acks from this account for a system where the rule is active. Hostacks are retrieved, edited and deleted by the \'id\' field. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `filterSystemProfileSapSidsContains?` | `string`[] | Are there systems which contain these SAP SIDs? | -| `filterSystemProfileSapSystem?` | `boolean` | Is this a SAP system? | -| `groups?` | `string`[] | List of Inventory host group names | -| `limit?` | `number` | Number of results to return per page. | -| `offset?` | `number` | The initial index from which to return the results. | -| `ruleId?` | `string`[] | Display host acknowledgement of this/these rules | -| `tags?` | `string`[] | Tags have a namespace, key and value in the form namespace/key=value | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`PaginatedHostAckList`](../interfaces/PaginatedHostAckList.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -HostackApi - -#### Defined in - -[api.ts:4817](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L4817) - -___ - -### hostackRetrieve - -▸ **hostackRetrieve**(`id`, `options?`): `Promise`\<`AxiosResponse`\<[`HostAck`](../interfaces/HostAck.md), `any`\>\> - -HostAcks acknowledge (and therefore hide) a rule from view in an account for a specific system. This view handles listing, retrieving, creating and deleting hostacks. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `number` | A unique integer value identifying this host ack. | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`HostAck`](../interfaces/HostAck.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -HostackApi - -#### Defined in - -[api.ts:4828](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L4828) - -___ - -### hostackUpdate - -▸ **hostackUpdate**(`id`, `hostAckJustification?`, `options?`): `Promise`\<`AxiosResponse`\<[`HostAckJustification`](../interfaces/HostAckJustification.md), `any`\>\> - -Update the justification for this host acknowledgement. The justification is taken from the request body. The created_by field is taken from the username in the x-rh-identity field, and the updated_at field is set to the current time. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `number` | A unique integer value identifying this host ack. | -| `hostAckJustification?` | [`HostAckJustification`](../interfaces/HostAckJustification.md) | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`HostAckJustification`](../interfaces/HostAckJustification.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -HostackApi - -#### Defined in - -[api.ts:4840](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L4840) diff --git a/packages/insights/doc/classes/KcsApi.md b/packages/insights/doc/classes/KcsApi.md deleted file mode 100644 index 542f9307c..000000000 --- a/packages/insights/doc/classes/KcsApi.md +++ /dev/null @@ -1,158 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / KcsApi - -# Class: KcsApi - -KcsApi - object-oriented interface - -**`Export`** - -KcsApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`KcsApi`** - -## Table of contents - -### Constructors - -- [constructor](KcsApi.md#constructor) - -### Properties - -- [axios](KcsApi.md#axios) -- [basePath](KcsApi.md#basepath) -- [configuration](KcsApi.md#configuration) - -### Methods - -- [kcsList](KcsApi.md#kcslist) -- [kcsRetrieve](KcsApi.md#kcsretrieve) - -## Constructors - -### constructor - -• **new KcsApi**(`configuration?`, `basePath?`, `axios?`): [`KcsApi`](KcsApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`KcsApi`](KcsApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L49) - -## Methods - -### kcsList - -▸ **kcsList**(`nodeIds?`, `options?`): `Promise`\<`AxiosResponse`\<[`Kcs`](../interfaces/Kcs.md)[], `any`\>\> - -Looks for all active rules with KCS solutions Returns a list of dicts of the C.R.C rule URL and its KCS solution number - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `nodeIds?` | `string`[] | Display the rule urls for the given list of comma separated KCS solution node_ids | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`Kcs`](../interfaces/Kcs.md)[], `any`\>\> - -**`Throws`** - -**`Memberof`** - -KcsApi - -#### Defined in - -[api.ts:5001](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L5001) - -___ - -### kcsRetrieve - -▸ **kcsRetrieve**(`nodeId`, `options?`): `Promise`\<`AxiosResponse`\<`string`[], `any`\>\> - -Gets active rule(s) for a particular KCS solution (node_id) Returns a list of C.R.C rule url(s) for that KCS solution - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `nodeId` | `string` | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`string`[], `any`\>\> - -**`Throws`** - -**`Memberof`** - -KcsApi - -#### Defined in - -[api.ts:5012](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L5012) diff --git a/packages/insights/doc/classes/PathwayApi.md b/packages/insights/doc/classes/PathwayApi.md deleted file mode 100644 index 913cbdad9..000000000 --- a/packages/insights/doc/classes/PathwayApi.md +++ /dev/null @@ -1,413 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / PathwayApi - -# Class: PathwayApi - -PathwayApi - object-oriented interface - -**`Export`** - -PathwayApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`PathwayApi`** - -## Table of contents - -### Constructors - -- [constructor](PathwayApi.md#constructor) - -### Properties - -- [axios](PathwayApi.md#axios) -- [basePath](PathwayApi.md#basepath) -- [configuration](PathwayApi.md#configuration) - -### Methods - -- [pathwayCreate](PathwayApi.md#pathwaycreate) -- [pathwayDestroy](PathwayApi.md#pathwaydestroy) -- [pathwayList](PathwayApi.md#pathwaylist) -- [pathwayReportsRetrieve](PathwayApi.md#pathwayreportsretrieve) -- [pathwayRetrieve](PathwayApi.md#pathwayretrieve) -- [pathwayRulesList](PathwayApi.md#pathwayruleslist) -- [pathwaySystemsList](PathwayApi.md#pathwaysystemslist) -- [pathwayUpdate](PathwayApi.md#pathwayupdate) - -## Constructors - -### constructor - -• **new PathwayApi**(`configuration?`, `basePath?`, `axios?`): [`PathwayApi`](PathwayApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`PathwayApi`](PathwayApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L49) - -## Methods - -### pathwayCreate - -▸ **pathwayCreate**(`pathwayInput`, `options?`): `Promise`\<`AxiosResponse`\<[`PathwayInput`](../interfaces/PathwayInput.md), `any`\>\> - -This creates a new Pathway in the system. Required fields are \"name,\" \"description,\" \"component,\" \"resolution_risk,\" and \"publish_date.\" \"name\" is a slug field and used to identify and retrieve Pathways for detailed analysis. The slug for a Pathway is auto-generated by converting the \"name\" to lowercase and replacing all spaces with dashes. \"resolution_risk\" should be the \"name\" of the ResolutionRisk to associate with this Pathway, not the risk value. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `pathwayInput` | [`PathwayInput`](../interfaces/PathwayInput.md) | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`PathwayInput`](../interfaces/PathwayInput.md), `any`\>\> - -**`Summary`** - -Create a new Pathway in the system - -**`Throws`** - -**`Memberof`** - -PathwayApi - -#### Defined in - -[api.ts:5912](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L5912) - -___ - -### pathwayDestroy - -▸ **pathwayDestroy**(`slug`, `options?`): `Promise`\<`AxiosResponse`\<`string`, `any`\>\> - -This will DELETE an existing Pathway in the system. Existing pathways are identified and deleted by the \"slug\" field. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `slug` | `string` | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`string`, `any`\>\> - -**`Summary`** - -Destroy an existing Pathway in the system - -**`Throws`** - -**`Memberof`** - -PathwayApi - -#### Defined in - -[api.ts:5924](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L5924) - -___ - -### pathwayList - -▸ **pathwayList**(`category?`, `filterSystemProfileAnsible?`, `filterSystemProfileMssql?`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `hasIncident?`, `impacting?`, `limit?`, `offset?`, `rebootRequired?`, `sort?`, `tags?`, `text?`, `options?`): `Promise`\<`AxiosResponse`\<[`PaginatedPathwayList`](../interfaces/PaginatedPathwayList.md), `any`\>\> - -This returns a list of all Pathways. Will display the same information as is provided in the retrieve view, but has all Pathways listed. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `category?` | (``1`` \| ``2`` \| ``3`` \| ``4``)[] | Filter rules of this category (number) | -| `filterSystemProfileAnsible?` | `boolean` | Is this an Ansible system? | -| `filterSystemProfileMssql?` | `boolean` | Is this a Microsoft SQL system? | -| `filterSystemProfileSapSidsContains?` | `string`[] | Are there systems which contain these SAP SIDs? | -| `filterSystemProfileSapSystem?` | `boolean` | Is this a SAP system? | -| `groups?` | `string`[] | List of Inventory host group names | -| `hasIncident?` | `boolean` | Display only pathways where there are incidents. | -| `impacting?` | `boolean` | Display pathways even if they aren\'t impacting systems currently | -| `limit?` | `number` | Number of results to return per page. | -| `offset?` | `number` | The initial index from which to return the results. | -| `rebootRequired?` | `boolean` | Display only pathways where reboot is required. | -| `sort?` | ``"-impacted_systems_count"`` \| ``"-name"`` \| ``"-recommendation_level"`` \| ``"impacted_systems_count"`` \| ``"name"`` \| ``"recommendation_level"`` | Order by this field | -| `tags?` | `string`[] | Tags have a namespace, key and value in the form namespace/key=value | -| `text?` | `string` | Filter pathway names with this text. If viewing details for a pathway for rules, reports and systems, additional filter on their text fields | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`PaginatedPathwayList`](../interfaces/PaginatedPathwayList.md), `any`\>\> - -**`Summary`** - -Return all pathways - -**`Throws`** - -**`Memberof`** - -PathwayApi - -#### Defined in - -[api.ts:5949](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L5949) - -___ - -### pathwayReportsRetrieve - -▸ **pathwayReportsRetrieve**(`slug`, `category?`, `groups?`, `hostId?`, `ruleId?`, `text?`, `updateMethod?`, `options?`): `Promise`\<`AxiosResponse`\<[`RuleSystemsExport`](../interfaces/RuleSystemsExport.md), `any`\>\> - -Each rule is listed once, with the systems currently reporting an incidence of that rule in a list. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `slug` | `string` | | -| `category?` | (``1`` \| ``2`` \| ``3`` \| ``4``)[] | Filter rules of this category (number) | -| `groups?` | `string`[] | List of Inventory host group names | -| `hostId?` | `string`[] | Display Pathway Reports of this/these systems | -| `ruleId?` | `string`[] | Display Pathway Reports of this/these rules | -| `text?` | `string` | Filter pathway names with this text. If viewing details for a pathway for rules, reports and systems, additional filter on their text fields | -| `updateMethod?` | (``"dnfyum"`` \| ``"ostree"``)[] | Search for systems with this updater type | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`RuleSystemsExport`](../interfaces/RuleSystemsExport.md), `any`\>\> - -**`Summary`** - -Get the list of systems for each rule in this pathway - -**`Throws`** - -**`Memberof`** - -PathwayApi - -#### Defined in - -[api.ts:5967](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L5967) - -___ - -### pathwayRetrieve - -▸ **pathwayRetrieve**(`slug`, `category?`, `filterSystemProfileAnsible?`, `filterSystemProfileMssql?`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `tags?`, `text?`, `options?`): `Promise`\<`AxiosResponse`\<[`Pathway`](../interfaces/Pathway.md), `any`\>\> - -This returns an individual pathway based on slug. Will display the same information as is provided in the list view. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `slug` | `string` | | -| `category?` | (``1`` \| ``2`` \| ``3`` \| ``4``)[] | Filter rules of this category (number) | -| `filterSystemProfileAnsible?` | `boolean` | Is this an Ansible system? | -| `filterSystemProfileMssql?` | `boolean` | Is this a Microsoft SQL system? | -| `filterSystemProfileSapSidsContains?` | `string`[] | Are there systems which contain these SAP SIDs? | -| `filterSystemProfileSapSystem?` | `boolean` | Is this a SAP system? | -| `groups?` | `string`[] | List of Inventory host group names | -| `tags?` | `string`[] | Tags have a namespace, key and value in the form namespace/key=value | -| `text?` | `string` | Filter pathway names with this text. If viewing details for a pathway for rules, reports and systems, additional filter on their text fields | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`Pathway`](../interfaces/Pathway.md), `any`\>\> - -**`Summary`** - -Returns an individual Pathway based on slug - -**`Throws`** - -**`Memberof`** - -PathwayApi - -#### Defined in - -[api.ts:5987](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L5987) - -___ - -### pathwayRulesList - -▸ **pathwayRulesList**(`slug`, `category?`, `limit?`, `offset?`, `text?`, `options?`): `Promise`\<`AxiosResponse`\<[`PaginatedRuleForAccountList`](../interfaces/PaginatedRuleForAccountList.md), `any`\>\> - -This view will retrieve/list in paginated format, all rules for a specific Pathway. This does not take into account acks or host asks. The Specific Pathway is requested by its slug - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `slug` | `string` | | -| `category?` | (``1`` \| ``2`` \| ``3`` \| ``4``)[] | Filter rules of this category (number) | -| `limit?` | `number` | Number of results to return per page. | -| `offset?` | `number` | The initial index from which to return the results. | -| `text?` | `string` | Filter pathway names with this text. If viewing details for a pathway for rules, reports and systems, additional filter on their text fields | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`PaginatedRuleForAccountList`](../interfaces/PaginatedRuleForAccountList.md), `any`\>\> - -**`Summary`** - -Get all rules in a Pathway - -**`Throws`** - -**`Memberof`** - -PathwayApi - -#### Defined in - -[api.ts:6003](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L6003) - -___ - -### pathwaySystemsList - -▸ **pathwaySystemsList**(`slug`, `category?`, `filterSystemProfileAnsible?`, `filterSystemProfileMssql?`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `limit?`, `offset?`, `tags?`, `text?`, `updateMethod?`, `options?`): `Promise`\<`AxiosResponse`\<[`PaginatedSystemList`](../interfaces/PaginatedSystemList.md), `any`\>\> - -This view will retrieve/list in paginated format, all impacted systems for an account, for a specific Pathway. The specific Pathway is requested by its slug. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `slug` | `string` | | -| `category?` | (``1`` \| ``2`` \| ``3`` \| ``4``)[] | Filter rules of this category (number) | -| `filterSystemProfileAnsible?` | `boolean` | Is this an Ansible system? | -| `filterSystemProfileMssql?` | `boolean` | Is this a Microsoft SQL system? | -| `filterSystemProfileSapSidsContains?` | `string`[] | Are there systems which contain these SAP SIDs? | -| `filterSystemProfileSapSystem?` | `boolean` | Is this a SAP system? | -| `groups?` | `string`[] | List of Inventory host group names | -| `limit?` | `number` | Number of results to return per page. | -| `offset?` | `number` | The initial index from which to return the results. | -| `tags?` | `string`[] | Tags have a namespace, key and value in the form namespace/key=value | -| `text?` | `string` | Filter pathway names with this text. If viewing details for a pathway for rules, reports and systems, additional filter on their text fields | -| `updateMethod?` | (``"dnfyum"`` \| ``"ostree"``)[] | Search for systems with this updater type | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`PaginatedSystemList`](../interfaces/PaginatedSystemList.md), `any`\>\> - -**`Summary`** - -Get all impacted systems for an account for a specific Pathway - -**`Throws`** - -**`Memberof`** - -PathwayApi - -#### Defined in - -[api.ts:6026](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L6026) - -___ - -### pathwayUpdate - -▸ **pathwayUpdate**(`slug`, `pathwayInput`, `options?`): `Promise`\<`AxiosResponse`\<[`PathwayInput`](../interfaces/PathwayInput.md), `any`\>\> - -This updates an existing Pathway already defined in the system. All fields that are required to define a Pathway initially may be updated here as well. Pathways are idenfitied and updated by the \"slug\" field. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `slug` | `string` | | -| `pathwayInput` | [`PathwayInput`](../interfaces/PathwayInput.md) | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`PathwayInput`](../interfaces/PathwayInput.md), `any`\>\> - -**`Summary`** - -Update an existing Pathway in the system - -**`Throws`** - -**`Memberof`** - -PathwayApi - -#### Defined in - -[api.ts:6039](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L6039) diff --git a/packages/insights/doc/classes/RatingApi.md b/packages/insights/doc/classes/RatingApi.md deleted file mode 100644 index 359c558d2..000000000 --- a/packages/insights/doc/classes/RatingApi.md +++ /dev/null @@ -1,255 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / RatingApi - -# Class: RatingApi - -RatingApi - object-oriented interface - -**`Export`** - -RatingApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`RatingApi`** - -## Table of contents - -### Constructors - -- [constructor](RatingApi.md#constructor) - -### Properties - -- [axios](RatingApi.md#axios) -- [basePath](RatingApi.md#basepath) -- [configuration](RatingApi.md#configuration) - -### Methods - -- [ratingAllRatingsList](RatingApi.md#ratingallratingslist) -- [ratingCreate](RatingApi.md#ratingcreate) -- [ratingList](RatingApi.md#ratinglist) -- [ratingRetrieve](RatingApi.md#ratingretrieve) -- [ratingStatsList](RatingApi.md#ratingstatslist) - -## Constructors - -### constructor - -• **new RatingApi**(`configuration?`, `basePath?`, `axios?`): [`RatingApi`](RatingApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`RatingApi`](RatingApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L49) - -## Methods - -### ratingAllRatingsList - -▸ **ratingAllRatingsList**(`limit?`, `offset?`, `options?`): `Promise`\<`AxiosResponse`\<[`PaginatedAllRuleRatingsList`](../interfaces/PaginatedAllRuleRatingsList.md), `any`\>\> - -Show all ratings. Available only to internal users. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `limit?` | `number` | Number of results to return per page. | -| `offset?` | `number` | The initial index from which to return the results. | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`PaginatedAllRuleRatingsList`](../interfaces/PaginatedAllRuleRatingsList.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -RatingApi - -#### Defined in - -[api.ts:6437](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L6437) - -___ - -### ratingCreate - -▸ **ratingCreate**(`ruleRating`, `options?`): `Promise`\<`AxiosResponse`\<[`RuleRating`](../interfaces/RuleRating.md), `any`\>\> - -Add or update a rating for a rule, by rule ID. Return the new rating. Any previous rating for this rule by this user is amended to the current value. This does not attempt to delete a rating by this user of this rule if the rating is zero. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `ruleRating` | [`RuleRating`](../interfaces/RuleRating.md) | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`RuleRating`](../interfaces/RuleRating.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -RatingApi - -#### Defined in - -[api.ts:6448](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L6448) - -___ - -### ratingList - -▸ **ratingList**(`limit?`, `offset?`, `options?`): `Promise`\<`AxiosResponse`\<[`PaginatedRuleRatingList`](../interfaces/PaginatedRuleRatingList.md), `any`\>\> - -List all rules rated by the current user Only the current user\'s ratings are listed here. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `limit?` | `number` | Number of results to return per page. | -| `offset?` | `number` | The initial index from which to return the results. | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`PaginatedRuleRatingList`](../interfaces/PaginatedRuleRatingList.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -RatingApi - -#### Defined in - -[api.ts:6460](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L6460) - -___ - -### ratingRetrieve - -▸ **ratingRetrieve**(`rule`, `options?`): `Promise`\<`AxiosResponse`\<[`RuleRating`](../interfaces/RuleRating.md), `any`\>\> - -Retrieve the ratings for a single rule, by Insights Rule ID - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `rule` | `string` | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`RuleRating`](../interfaces/RuleRating.md), `any`\>\> - -**`Summary`** - -Retrieve the ratings for a single rule - -**`Throws`** - -**`Memberof`** - -RatingApi - -#### Defined in - -[api.ts:6472](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L6472) - -___ - -### ratingStatsList - -▸ **ratingStatsList**(`limit?`, `offset?`, `options?`): `Promise`\<`AxiosResponse`\<[`PaginatedRuleRatingStatsList`](../interfaces/PaginatedRuleRatingStatsList.md), `any`\>\> - -Summarise the ratings for a rule. This summarises the statistics for each rule. Available only to internal users. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `limit?` | `number` | Number of results to return per page. | -| `offset?` | `number` | The initial index from which to return the results. | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`PaginatedRuleRatingStatsList`](../interfaces/PaginatedRuleRatingStatsList.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -RatingApi - -#### Defined in - -[api.ts:6484](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L6484) diff --git a/packages/insights/doc/classes/RuleApi.md b/packages/insights/doc/classes/RuleApi.md deleted file mode 100644 index 40cd99085..000000000 --- a/packages/insights/doc/classes/RuleApi.md +++ /dev/null @@ -1,390 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / RuleApi - -# Class: RuleApi - -RuleApi - object-oriented interface - -**`Export`** - -RuleApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`RuleApi`** - -## Table of contents - -### Constructors - -- [constructor](RuleApi.md#constructor) - -### Properties - -- [axios](RuleApi.md#axios) -- [basePath](RuleApi.md#basepath) -- [configuration](RuleApi.md#configuration) - -### Methods - -- [ruleAckHostsCreate](RuleApi.md#ruleackhostscreate) -- [ruleJustificationsList](RuleApi.md#rulejustificationslist) -- [ruleList](RuleApi.md#rulelist) -- [ruleRetrieve](RuleApi.md#ruleretrieve) -- [ruleStatsRetrieve](RuleApi.md#rulestatsretrieve) -- [ruleSystemsDetailList](RuleApi.md#rulesystemsdetaillist) -- [ruleSystemsRetrieve](RuleApi.md#rulesystemsretrieve) -- [ruleUnackHostsCreate](RuleApi.md#ruleunackhostscreate) - -## Constructors - -### constructor - -• **new RuleApi**(`configuration?`, `basePath?`, `axios?`): [`RuleApi`](RuleApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`RuleApi`](RuleApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L49) - -## Methods - -### ruleAckHostsCreate - -▸ **ruleAckHostsCreate**(`ruleId`, `multiHostAck`, `options?`): `Promise`\<`AxiosResponse`\<[`MultiAckResponse`](../interfaces/MultiAckResponse.md), `any`\>\> - -Add acknowledgements for one or more hosts to this rule. Host acknowledgements will be added to this rule in this account for the system UUIDs supplied. The justification supplied will be given for all host acks created. Any existing host acknowledgements for a host on this rule will be updated. The count of created hosts acknowledgements, and the list of systems now impacted by this rule, will be returned. Account-wide acks are unaffected. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `ruleId` | `string` | | -| `multiHostAck` | [`MultiHostAck`](../interfaces/MultiHostAck.md) | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`MultiAckResponse`](../interfaces/MultiAckResponse.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -RuleApi - -#### Defined in - -[api.ts:7424](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L7424) - -___ - -### ruleJustificationsList - -▸ **ruleJustificationsList**(`ruleId`, `limit?`, `offset?`, `options?`): `Promise`\<`AxiosResponse`\<[`PaginatedJustificationCountList`](../interfaces/PaginatedJustificationCountList.md), `any`\>\> - -List all justifications given for disabling this rule. This is an **internal-only** view that allows us to provide feedback on why rules are disabled by our customers. It lists the justifications given in both account-wide acks and host-specific acks of a rule. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `ruleId` | `string` | | -| `limit?` | `number` | Number of results to return per page. | -| `offset?` | `number` | The initial index from which to return the results. | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`PaginatedJustificationCountList`](../interfaces/PaginatedJustificationCountList.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -RuleApi - -#### Defined in - -[api.ts:7437](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L7437) - -___ - -### ruleList - -▸ **ruleList**(`category?`, `filterSystemProfileAnsible?`, `filterSystemProfileMssql?`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `hasPlaybook?`, `hasTag?`, `impact?`, `impacting?`, `incident?`, `likelihood?`, `limit?`, `offset?`, `pathway?`, `reboot?`, `reportsShown?`, `resRisk?`, `ruleStatus?`, `sort?`, `tags?`, `text?`, `topic?`, `totalRisk?`, `updateMethod?`, `options?`): `Promise`\<`AxiosResponse`\<[`PaginatedRuleForAccountList`](../interfaces/PaginatedRuleForAccountList.md), `any`\>\> - -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. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `category?` | (``1`` \| ``2`` \| ``3`` \| ``4``)[] | Display rules of this category (number) | -| `filterSystemProfileAnsible?` | `boolean` | Is this an Ansible system? | -| `filterSystemProfileMssql?` | `boolean` | Is this a Microsoft SQL system? | -| `filterSystemProfileSapSidsContains?` | `string`[] | Are there systems which contain these SAP SIDs? | -| `filterSystemProfileSapSystem?` | `boolean` | Is this a SAP system? | -| `groups?` | `string`[] | List of Inventory host group names | -| `hasPlaybook?` | `boolean` | Display rules that have a playbook | -| `hasTag?` | `string`[] | Display rules that have (one or more) tags | -| `impact?` | (``1`` \| ``2`` \| ``3`` \| ``4``)[] | Display rules of this impact level (1..4) | -| `impacting?` | `boolean` | Display only rules that are impacting systems currently | -| `incident?` | `boolean` | Display only rules that cause an incident | -| `likelihood?` | (``1`` \| ``2`` \| ``3`` \| ``4``)[] | Display only rules of this likelihood level (1..4) | -| `limit?` | `number` | Number of results to return per page. | -| `offset?` | `number` | The initial index from which to return the results. | -| `pathway?` | `string` | Display rules of this Pathway | -| `reboot?` | `boolean` | Display rules that require a reboot to fix | -| `reportsShown?` | `boolean` | Display rules where reports are shown or not | -| `resRisk?` | (``1`` \| ``2`` \| ``3`` \| ``4``)[] | Display rules with this resolution risk level (1..4) | -| `ruleStatus?` | ``"all"`` \| ``"disabled"`` \| ``"enabled"`` \| ``"rhdisabled"`` | Display rules which are enabled, disabled (acked) by user, or disabled (acked) by Red Hat | -| `sort?` | (``"-category"`` \| ``"-description"`` \| ``"-impact"`` \| ``"-impacted_count"`` \| ``"-likelihood"`` \| ``"-playbook_count"`` \| ``"-publish_date"`` \| ``"-resolution_risk"`` \| ``"-rule_id"`` \| ``"-total_risk"`` \| ``"category"`` \| ``"description"`` \| ``"impact"`` \| ``"impacted_count"`` \| ``"likelihood"`` \| ``"playbook_count"`` \| ``"publish_date"`` \| ``"resolution_risk"`` \| ``"rule_id"`` \| ``"total_risk"``)[] | Order by this field | -| `tags?` | `string`[] | Tags have a namespace, key and value in the form namespace/key=value | -| `text?` | `string` | Display rules with this text in their text fields | -| `topic?` | `string` | Display rules in this topic (slug) | -| `totalRisk?` | (``1`` \| ``2`` \| ``3`` \| ``4``)[] | Display rules with this total risk level (1..4) | -| `updateMethod?` | (``"dnfyum"`` \| ``"ostree"``)[] | Search for systems with this updater type | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`PaginatedRuleForAccountList`](../interfaces/PaginatedRuleForAccountList.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -RuleApi - -#### Defined in - -[api.ts:7472](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L7472) - -___ - -### ruleRetrieve - -▸ **ruleRetrieve**(`ruleId`, `groups?`, `tags?`, `options?`): `Promise`\<`AxiosResponse`\<[`RuleForAccount`](../interfaces/RuleForAccount.md), `any`\>\> - -Retrieve a single rule and its associated details. This includes the account-relevant details such as number of impacted systems and host acknowledgements. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `ruleId` | `string` | | -| `groups?` | `string`[] | List of Inventory host group names | -| `tags?` | `string`[] | Tags have a namespace, key and value in the form namespace/key=value | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`RuleForAccount`](../interfaces/RuleForAccount.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -RuleApi - -#### Defined in - -[api.ts:7485](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L7485) - -___ - -### ruleStatsRetrieve - -▸ **ruleStatsRetrieve**(`ruleId`, `options?`): `Promise`\<`AxiosResponse`\<[`RuleUsageStats`](../interfaces/RuleUsageStats.md), `any`\>\> - -Display usage and impact statistics for this rule. For internal use only. This allows rule developers to see the number of systems and accounts impacted by a rule. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `ruleId` | `string` | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`RuleUsageStats`](../interfaces/RuleUsageStats.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -RuleApi - -#### Defined in - -[api.ts:7496](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L7496) - -___ - -### ruleSystemsDetailList - -▸ **ruleSystemsDetailList**(`ruleId`, `filterSystemProfileAnsible?`, `filterSystemProfileMssql?`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `limit?`, `name?`, `offset?`, `rhelVersion?`, `sort?`, `tags?`, `options?`): `Promise`\<`AxiosResponse`\<[`PaginatedSystemsDetailList`](../interfaces/PaginatedSystemsDetailList.md), `any`\>\> - -List systems affected by this rule with additional information about each system All systems owned by the user\'s account, with a current upload reporting the given rule, are listed in a paginated format. Additional information includes hit counts and upload/stale timestamps. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `ruleId` | `string` | | -| `filterSystemProfileAnsible?` | `boolean` | Is this an Ansible system? | -| `filterSystemProfileMssql?` | `boolean` | Is this a Microsoft SQL system? | -| `filterSystemProfileSapSidsContains?` | `string`[] | Are there systems which contain these SAP SIDs? | -| `filterSystemProfileSapSystem?` | `boolean` | Is this a SAP system? | -| `groups?` | `string`[] | List of Inventory host group names | -| `limit?` | `number` | Number of results to return per page. | -| `name?` | `string` | Search for systems that include this in their display name | -| `offset?` | `number` | The initial index from which to return the results. | -| `rhelVersion?` | (``"6.0"`` \| ``"6.1"`` \| ``"6.10"`` \| ``"6.2"`` \| ``"6.3"`` \| ``"6.4"`` \| ``"6.5"`` \| ``"6.6"`` \| ``"6.7"`` \| ``"6.8"`` \| ``"6.9"`` \| ``"7.0"`` \| ``"7.1"`` \| ``"7.10"`` \| ``"7.2"`` \| ``"7.3"`` \| ``"7.4"`` \| ``"7.5"`` \| ``"7.6"`` \| ``"7.7"`` \| ``"7.8"`` \| ``"7.9"`` \| ``"8.0"`` \| ``"8.1"`` \| ``"8.10"`` \| ``"8.2"`` \| ``"8.3"`` \| ``"8.4"`` \| ``"8.5"`` \| ``"8.6"`` \| ``"8.7"`` \| ``"8.8"`` \| ``"8.9"`` \| ``"9.0"`` \| ``"9.1"`` \| ``"9.2"`` \| ``"9.3"`` \| ``"9.4"`` \| ``"9.5"``)[] | Display only systems with these versions of RHEL | -| `sort?` | ``"-critical_hits"`` \| ``"-display_name"`` \| ``"-group_name"`` \| ``"-hits"`` \| ``"-important_hits"`` \| ``"-last_seen"`` \| ``"-low_hits"`` \| ``"-moderate_hits"`` \| ``"-rhel_version"`` \| ``"critical_hits"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"hits"`` \| ``"important_hits"`` \| ``"last_seen"`` \| ``"low_hits"`` \| ``"moderate_hits"`` \| ``"rhel_version"`` \| ``"-impacted_date"`` \| ``"impacted_date"`` | Order by this field | -| `tags?` | `string`[] | Tags have a namespace, key and value in the form namespace/key=value | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`PaginatedSystemsDetailList`](../interfaces/PaginatedSystemsDetailList.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -RuleApi - -#### Defined in - -[api.ts:7518](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L7518) - -___ - -### ruleSystemsRetrieve - -▸ **ruleSystemsRetrieve**(`ruleId`, `filterSystemProfileAnsible?`, `filterSystemProfileMssql?`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `format?`, `groups?`, `name?`, `rhelVersion?`, `sort?`, `tags?`, `updateMethod?`, `options?`): `Promise`\<`AxiosResponse`\<[`SystemsForRule`](../interfaces/SystemsForRule.md), `any`\>\> - -List all systems affected by this rule. All systems owned by the user\'s account, with a current upload reporting the given rule, are listed. Systems are simply listed by Insights Inventory UUID. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `ruleId` | `string` | | -| `filterSystemProfileAnsible?` | `boolean` | Is this an Ansible system? | -| `filterSystemProfileMssql?` | `boolean` | Is this a Microsoft SQL system? | -| `filterSystemProfileSapSidsContains?` | `string`[] | Are there systems which contain these SAP SIDs? | -| `filterSystemProfileSapSystem?` | `boolean` | Is this a SAP system? | -| `format?` | ``"csv"`` \| ``"json"`` | | -| `groups?` | `string`[] | List of Inventory host group names | -| `name?` | `string` | Search for systems that include this in their display name | -| `rhelVersion?` | (``"6.0"`` \| ``"6.1"`` \| ``"6.10"`` \| ``"6.2"`` \| ``"6.3"`` \| ``"6.4"`` \| ``"6.5"`` \| ``"6.6"`` \| ``"6.7"`` \| ``"6.8"`` \| ``"6.9"`` \| ``"7.0"`` \| ``"7.1"`` \| ``"7.10"`` \| ``"7.2"`` \| ``"7.3"`` \| ``"7.4"`` \| ``"7.5"`` \| ``"7.6"`` \| ``"7.7"`` \| ``"7.8"`` \| ``"7.9"`` \| ``"8.0"`` \| ``"8.1"`` \| ``"8.10"`` \| ``"8.2"`` \| ``"8.3"`` \| ``"8.4"`` \| ``"8.5"`` \| ``"8.6"`` \| ``"8.7"`` \| ``"8.8"`` \| ``"8.9"`` \| ``"9.0"`` \| ``"9.1"`` \| ``"9.2"`` \| ``"9.3"`` \| ``"9.4"`` \| ``"9.5"``)[] | Display only systems with these versions of RHEL | -| `sort?` | (``"-display_name"`` \| ``"-last_seen"`` \| ``"display_name"`` \| ``"last_seen"`` \| ``"-stale_at"`` \| ``"-system_uuid"`` \| ``"-updated"`` \| ``"stale_at"`` \| ``"system_uuid"`` \| ``"updated"``)[] | Order by this field | -| `tags?` | `string`[] | Tags have a namespace, key and value in the form namespace/key=value | -| `updateMethod?` | (``"dnfyum"`` \| ``"ostree"``)[] | Search for systems with this updater type | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`SystemsForRule`](../interfaces/SystemsForRule.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -RuleApi - -#### Defined in - -[api.ts:7540](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L7540) - -___ - -### ruleUnackHostsCreate - -▸ **ruleUnackHostsCreate**(`ruleId`, `multiHostUnAck`, `options?`): `Promise`\<`AxiosResponse`\<[`MultiAckResponse`](../interfaces/MultiAckResponse.md), `any`\>\> - -Delete acknowledgements for one or more hosts to this rule. Any host acknowledgements for this rule in this account for the given system are deleted. Hosts that do not have an acknowledgement for this rule in this account are ignored. The count of deleted host acknowledgements, and the list of hosts now impacted by this rule, will be returned. Account-wide acks are unaffected. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `ruleId` | `string` | | -| `multiHostUnAck` | [`MultiHostUnAck`](../interfaces/MultiHostUnAck.md) | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`MultiAckResponse`](../interfaces/MultiAckResponse.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -RuleApi - -#### Defined in - -[api.ts:7552](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L7552) diff --git a/packages/insights/doc/classes/RulecategoryApi.md b/packages/insights/doc/classes/RulecategoryApi.md deleted file mode 100644 index 5cd841eac..000000000 --- a/packages/insights/doc/classes/RulecategoryApi.md +++ /dev/null @@ -1,157 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / RulecategoryApi - -# Class: RulecategoryApi - -RulecategoryApi - object-oriented interface - -**`Export`** - -RulecategoryApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`RulecategoryApi`** - -## Table of contents - -### Constructors - -- [constructor](RulecategoryApi.md#constructor) - -### Properties - -- [axios](RulecategoryApi.md#axios) -- [basePath](RulecategoryApi.md#basepath) -- [configuration](RulecategoryApi.md#configuration) - -### Methods - -- [rulecategoryList](RulecategoryApi.md#rulecategorylist) -- [rulecategoryRetrieve](RulecategoryApi.md#rulecategoryretrieve) - -## Constructors - -### constructor - -• **new RulecategoryApi**(`configuration?`, `basePath?`, `axios?`): [`RulecategoryApi`](RulecategoryApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`RulecategoryApi`](RulecategoryApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L49) - -## Methods - -### rulecategoryList - -▸ **rulecategoryList**(`options?`): `Promise`\<`AxiosResponse`\<[`RuleCategory`](../interfaces/RuleCategory.md)[], `any`\>\> - -Rules are divided into categories, the usual being Availability, Stability, Security and Performance. Categories are listed in decreasing order of importance. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`RuleCategory`](../interfaces/RuleCategory.md)[], `any`\>\> - -**`Throws`** - -**`Memberof`** - -RulecategoryApi - -#### Defined in - -[api.ts:7705](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L7705) - -___ - -### rulecategoryRetrieve - -▸ **rulecategoryRetrieve**(`id`, `options?`): `Promise`\<`AxiosResponse`\<[`RuleCategory`](../interfaces/RuleCategory.md), `any`\>\> - -Rules are divided into categories, the usual being Availability, Stability, Security and Performance. Categories are listed in decreasing order of importance. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `number` | A unique integer value identifying this rule category. | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`RuleCategory`](../interfaces/RuleCategory.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -RulecategoryApi - -#### Defined in - -[api.ts:7716](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L7716) diff --git a/packages/insights/doc/classes/SettingsApi.md b/packages/insights/doc/classes/SettingsApi.md deleted file mode 100644 index 98c34e6d4..000000000 --- a/packages/insights/doc/classes/SettingsApi.md +++ /dev/null @@ -1,127 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / SettingsApi - -# Class: SettingsApi - -SettingsApi - object-oriented interface - -**`Export`** - -SettingsApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`SettingsApi`** - -## Table of contents - -### Constructors - -- [constructor](SettingsApi.md#constructor) - -### Properties - -- [axios](SettingsApi.md#axios) -- [basePath](SettingsApi.md#basepath) -- [configuration](SettingsApi.md#configuration) - -### Methods - -- [settingsList](SettingsApi.md#settingslist) - -## Constructors - -### constructor - -• **new SettingsApi**(`configuration?`, `basePath?`, `axios?`): [`SettingsApi`](SettingsApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`SettingsApi`](SettingsApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L49) - -## Methods - -### settingsList - -▸ **settingsList**(`options?`): `Promise`\<`AxiosResponse`\<[`SettingsDDF`](../interfaces/SettingsDDF.md)[], `any`\>\> - -Describe the settings we have in a Data-Driven Forms way. This simply compiles the \'show_satellite_hosts\' account-wide setting into a format compatible with Data-Driven Forms. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`SettingsDDF`](../interfaces/SettingsDDF.md)[], `any`\>\> - -**`Throws`** - -**`Memberof`** - -SettingsApi - -#### Defined in - -[api.ts:7820](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L7820) diff --git a/packages/insights/doc/classes/StatsApi.md b/packages/insights/doc/classes/StatsApi.md deleted file mode 100644 index 735fe3e82..000000000 --- a/packages/insights/doc/classes/StatsApi.md +++ /dev/null @@ -1,259 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / StatsApi - -# Class: StatsApi - -StatsApi - object-oriented interface - -**`Export`** - -StatsApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`StatsApi`** - -## Table of contents - -### Constructors - -- [constructor](StatsApi.md#constructor) - -### Properties - -- [axios](StatsApi.md#axios) -- [basePath](StatsApi.md#basepath) -- [configuration](StatsApi.md#configuration) - -### Methods - -- [statsList](StatsApi.md#statslist) -- [statsOverviewRetrieve](StatsApi.md#statsoverviewretrieve) -- [statsReportsRetrieve](StatsApi.md#statsreportsretrieve) -- [statsRulesRetrieve](StatsApi.md#statsrulesretrieve) -- [statsSystemsRetrieve](StatsApi.md#statssystemsretrieve) - -## Constructors - -### constructor - -• **new StatsApi**(`configuration?`, `basePath?`, `axios?`): [`StatsApi`](StatsApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`StatsApi`](StatsApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L49) - -## Methods - -### statsList - -▸ **statsList**(`options?`): `Promise`\<`AxiosResponse`\<`string`[][], `any`\>\> - -Provide a simple list of URLs contained here. A list of statistics views. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`string`[][], `any`\>\> - -**`Throws`** - -**`Memberof`** - -StatsApi - -#### Defined in - -[api.ts:8264](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L8264) - -___ - -### statsOverviewRetrieve - -▸ **statsOverviewRetrieve**(`tags?`, `groups?`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsContains?`, `options?`): `Promise`\<`AxiosResponse`\<[`Stats`](../interfaces/Stats.md), `any`\>\> - -Show overview statistics for this user This gives the number of pathways, and incident, critical and important recommendations, affecting systems that the user can see. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `tags?` | `string`[] | Tags have a namespace, key and value in the form namespace/key=value | -| `groups?` | `string`[] | List of Inventory host group names | -| `filterSystemProfileSapSystem?` | `boolean` | Is this a SAP system? | -| `filterSystemProfileSapSidsContains?` | `string`[] | Are there systems which contain these SAP SIDs? | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`Stats`](../interfaces/Stats.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -StatsApi - -#### Defined in - -[api.ts:8278](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L8278) - -___ - -### statsReportsRetrieve - -▸ **statsReportsRetrieve**(`tags?`, `groups?`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsContains?`, `options?`): `Promise`\<`AxiosResponse`\<[`Stats`](../interfaces/Stats.md), `any`\>\> - -Show statistics of reports impacting across categories and risks. Only current reports are considered. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `tags?` | `string`[] | Tags have a namespace, key and value in the form namespace/key=value | -| `groups?` | `string`[] | List of Inventory host group names | -| `filterSystemProfileSapSystem?` | `boolean` | Is this a SAP system? | -| `filterSystemProfileSapSidsContains?` | `string`[] | Are there systems which contain these SAP SIDs? | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`Stats`](../interfaces/Stats.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -StatsApi - -#### Defined in - -[api.ts:8292](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L8292) - -___ - -### statsRulesRetrieve - -▸ **statsRulesRetrieve**(`tags?`, `groups?`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsContains?`, `options?`): `Promise`\<`AxiosResponse`\<[`Stats`](../interfaces/Stats.md), `any`\>\> - -Show statistics of rule usage across categories and risks. Only current reports are considered. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `tags?` | `string`[] | Tags have a namespace, key and value in the form namespace/key=value | -| `groups?` | `string`[] | List of Inventory host group names | -| `filterSystemProfileSapSystem?` | `boolean` | Is this a SAP system? | -| `filterSystemProfileSapSidsContains?` | `string`[] | Are there systems which contain these SAP SIDs? | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`Stats`](../interfaces/Stats.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -StatsApi - -#### Defined in - -[api.ts:8306](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L8306) - -___ - -### statsSystemsRetrieve - -▸ **statsSystemsRetrieve**(`tags?`, `groups?`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsContains?`, `options?`): `Promise`\<`AxiosResponse`\<[`Stats`](../interfaces/Stats.md), `any`\>\> - -Show statistics of systems being impacted across categories and risks. Only current reports are considered. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `tags?` | `string`[] | Tags have a namespace, key and value in the form namespace/key=value | -| `groups?` | `string`[] | List of Inventory host group names | -| `filterSystemProfileSapSystem?` | `boolean` | Is this a SAP system? | -| `filterSystemProfileSapSidsContains?` | `string`[] | Are there systems which contain these SAP SIDs? | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`Stats`](../interfaces/Stats.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -StatsApi - -#### Defined in - -[api.ts:8320](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L8320) diff --git a/packages/insights/doc/classes/StatusApi.md b/packages/insights/doc/classes/StatusApi.md deleted file mode 100644 index 61fb8fb4f..000000000 --- a/packages/insights/doc/classes/StatusApi.md +++ /dev/null @@ -1,185 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / StatusApi - -# Class: StatusApi - -StatusApi - object-oriented interface - -**`Export`** - -StatusApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`StatusApi`** - -## Table of contents - -### Constructors - -- [constructor](StatusApi.md#constructor) - -### Properties - -- [axios](StatusApi.md#axios) -- [basePath](StatusApi.md#basepath) -- [configuration](StatusApi.md#configuration) - -### Methods - -- [statusLiveRetrieve](StatusApi.md#statusliveretrieve) -- [statusReadyRetrieve](StatusApi.md#statusreadyretrieve) -- [statusRetrieve](StatusApi.md#statusretrieve) - -## Constructors - -### constructor - -• **new StatusApi**(`configuration?`, `basePath?`, `axios?`): [`StatusApi`](StatusApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`StatusApi`](StatusApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L49) - -## Methods - -### statusLiveRetrieve - -▸ **statusLiveRetrieve**(`options?`): `Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -Is the Advisor API live and serving requests? This returns a dictionary with properties defining the status of the components Advisor relies on. At the moment this is the same as the Readiness check (see `/ready/`). In the future it may include other checks if we need to, but the properties of `/ready/` will always be included. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -**`Throws`** - -**`Memberof`** - -StatusApi - -#### Defined in - -[api.ts:8514](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L8514) - -___ - -### statusReadyRetrieve - -▸ **statusReadyRetrieve**(`options?`): `Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -Is the Advisor API ready to serve requests? This returns a dictionary with properties defining the status of the components Advisor relies on. * \'django\' should always be True. If Django isn\'t ready, you can\'t get this information :-) * \'database\' is True when a database access returns successfully with valid information. * \'rbac\' is True when we can make a request to the RBAC API and get a valid response. * \'advisor\' is True if all of the above are True. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -**`Throws`** - -**`Memberof`** - -StatusApi - -#### Defined in - -[api.ts:8524](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L8524) - -___ - -### statusRetrieve - -▸ **statusRetrieve**(`options?`): `Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -Provide a simple list of URLs contained here. A list of statistics views. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -**`Throws`** - -**`Memberof`** - -StatusApi - -#### Defined in - -[api.ts:8534](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L8534) diff --git a/packages/insights/doc/classes/SystemApi.md b/packages/insights/doc/classes/SystemApi.md deleted file mode 100644 index 95d2e53f7..000000000 --- a/packages/insights/doc/classes/SystemApi.md +++ /dev/null @@ -1,249 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / SystemApi - -# Class: SystemApi - -SystemApi - object-oriented interface - -**`Export`** - -SystemApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`SystemApi`** - -## Table of contents - -### Constructors - -- [constructor](SystemApi.md#constructor) - -### Properties - -- [axios](SystemApi.md#axios) -- [basePath](SystemApi.md#basepath) -- [configuration](SystemApi.md#configuration) - -### Methods - -- [systemList](SystemApi.md#systemlist) -- [systemRenderedReportsList](SystemApi.md#systemrenderedreportslist) -- [systemReportsList](SystemApi.md#systemreportslist) -- [systemRetrieve](SystemApi.md#systemretrieve) - -## Constructors - -### constructor - -• **new SystemApi**(`configuration?`, `basePath?`, `axios?`): [`SystemApi`](SystemApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`SystemApi`](SystemApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L49) - -## Methods - -### systemList - -▸ **systemList**(`displayName?`, `filterSystemProfileAnsible?`, `filterSystemProfileMssql?`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `hits?`, `incident?`, `limit?`, `offset?`, `pathway?`, `rhelVersion?`, `sort?`, `tags?`, `updateMethod?`, `options?`): `Promise`\<`AxiosResponse`\<[`PaginatedSystemList`](../interfaces/PaginatedSystemList.md), `any`\>\> - -Returns systems with their hit count and last upload time. Results can be sorted and systems can be filtered by display name and hits - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `displayName?` | `string` | Display systems with this text in their display_name | -| `filterSystemProfileAnsible?` | `boolean` | Is this an Ansible system? | -| `filterSystemProfileMssql?` | `boolean` | Is this a Microsoft SQL system? | -| `filterSystemProfileSapSidsContains?` | `string`[] | Are there systems which contain these SAP SIDs? | -| `filterSystemProfileSapSystem?` | `boolean` | Is this a SAP system? | -| `groups?` | `string`[] | List of Inventory host group names | -| `hits?` | (``"all"`` \| ``"1"`` \| ``"2"`` \| ``"3"`` \| ``"4"`` \| ``"no"`` \| ``"yes"``)[] | Display systems with hits of the given total_risk value (1..4), or 0 to display all systems | -| `incident?` | `boolean` | Display only systems reporting an incident | -| `limit?` | `number` | Number of results to return per page. | -| `offset?` | `number` | The initial index from which to return the results. | -| `pathway?` | `string` | Display systems with rule hits for this Pathway | -| `rhelVersion?` | (``"6.0"`` \| ``"6.1"`` \| ``"6.10"`` \| ``"6.2"`` \| ``"6.3"`` \| ``"6.4"`` \| ``"6.5"`` \| ``"6.6"`` \| ``"6.7"`` \| ``"6.8"`` \| ``"6.9"`` \| ``"7.0"`` \| ``"7.1"`` \| ``"7.10"`` \| ``"7.2"`` \| ``"7.3"`` \| ``"7.4"`` \| ``"7.5"`` \| ``"7.6"`` \| ``"7.7"`` \| ``"7.8"`` \| ``"7.9"`` \| ``"8.0"`` \| ``"8.1"`` \| ``"8.10"`` \| ``"8.2"`` \| ``"8.3"`` \| ``"8.4"`` \| ``"8.5"`` \| ``"8.6"`` \| ``"8.7"`` \| ``"8.8"`` \| ``"8.9"`` \| ``"9.0"`` \| ``"9.1"`` \| ``"9.2"`` \| ``"9.3"`` \| ``"9.4"`` \| ``"9.5"``)[] | Display only systems with these versions of RHEL | -| `sort?` | ``"-critical_hits"`` \| ``"-display_name"`` \| ``"-group_name"`` \| ``"-hits"`` \| ``"-important_hits"`` \| ``"-last_seen"`` \| ``"-low_hits"`` \| ``"-moderate_hits"`` \| ``"-rhel_version"`` \| ``"critical_hits"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"hits"`` \| ``"important_hits"`` \| ``"last_seen"`` \| ``"low_hits"`` \| ``"moderate_hits"`` \| ``"rhel_version"`` | Order by this field | -| `tags?` | `string`[] | Tags have a namespace, key and value in the form namespace/key=value | -| `updateMethod?` | (``"dnfyum"`` \| ``"ostree"``)[] | Search for systems with this updater type | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`PaginatedSystemList`](../interfaces/PaginatedSystemList.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -SystemApi - -#### Defined in - -[api.ts:9047](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L9047) - -___ - -### systemRenderedReportsList - -▸ **systemRenderedReportsList**(`uuid`, `filterSystemProfileAnsible?`, `filterSystemProfileMssql?`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `tags?`, `updateMethod?`, `options?`): `Promise`\<`AxiosResponse`\<[`RenderedReport`](../interfaces/RenderedReport.md)[], `any`\>\> - -Returns the list of reports for an Inventory Host ID, with the rule templates filled in thanks to node.js and DoT and Markdown. If the host ID is not found, return an empty list. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `uuid` | `string` | A UUID string identifying this inventory host. | -| `filterSystemProfileAnsible?` | `boolean` | Is this an Ansible system? | -| `filterSystemProfileMssql?` | `boolean` | Is this a Microsoft SQL system? | -| `filterSystemProfileSapSidsContains?` | `string`[] | Are there systems which contain these SAP SIDs? | -| `filterSystemProfileSapSystem?` | `boolean` | Is this a SAP system? | -| `tags?` | `string`[] | Tags have a namespace, key and value in the form namespace/key=value | -| `updateMethod?` | (``"dnfyum"`` \| ``"ostree"``)[] | Search for systems with this updater type | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`RenderedReport`](../interfaces/RenderedReport.md)[], `any`\>\> - -**`Throws`** - -**`Memberof`** - -SystemApi - -#### Defined in - -[api.ts:9064](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L9064) - -___ - -### systemReportsList - -▸ **systemReportsList**(`uuid`, `filterSystemProfileAnsible?`, `filterSystemProfileMssql?`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `tags?`, `updateMethod?`, `options?`): `Promise`\<`AxiosResponse`\<[`Report`](../interfaces/Report.md)[], `any`\>\> - -Returns the list of latest reports for an Inventory Host ID. Returns reports that: * are in the user\'s account * have an active, not-deleted rule * where the rule has not been acked by this account If the host ID is not found, return an empty list. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `uuid` | `string` | A UUID string identifying this inventory host. | -| `filterSystemProfileAnsible?` | `boolean` | Is this an Ansible system? | -| `filterSystemProfileMssql?` | `boolean` | Is this a Microsoft SQL system? | -| `filterSystemProfileSapSidsContains?` | `string`[] | Are there systems which contain these SAP SIDs? | -| `filterSystemProfileSapSystem?` | `boolean` | Is this a SAP system? | -| `groups?` | `string`[] | List of Inventory host group names | -| `tags?` | `string`[] | Tags have a namespace, key and value in the form namespace/key=value | -| `updateMethod?` | (``"dnfyum"`` \| ``"ostree"``)[] | Search for systems with this updater type | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`Report`](../interfaces/Report.md)[], `any`\>\> - -**`Throws`** - -**`Memberof`** - -SystemApi - -#### Defined in - -[api.ts:9082](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L9082) - -___ - -### systemRetrieve - -▸ **systemRetrieve**(`uuid`, `options?`): `Promise`\<`AxiosResponse`\<[`System`](../interfaces/System.md), `any`\>\> - -Retrieve the reports for a single system by Insights Inventory UUID - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `uuid` | `string` | A UUID string identifying this inventory host. | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`System`](../interfaces/System.md), `any`\>\> - -**`Summary`** - -Retrieve the reports for a single system - -**`Throws`** - -**`Memberof`** - -SystemApi - -#### Defined in - -[api.ts:9094](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L9094) diff --git a/packages/insights/doc/classes/SystemtypeApi.md b/packages/insights/doc/classes/SystemtypeApi.md deleted file mode 100644 index 7011379e0..000000000 --- a/packages/insights/doc/classes/SystemtypeApi.md +++ /dev/null @@ -1,165 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / SystemtypeApi - -# Class: SystemtypeApi - -SystemtypeApi - object-oriented interface - -**`Export`** - -SystemtypeApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`SystemtypeApi`** - -## Table of contents - -### Constructors - -- [constructor](SystemtypeApi.md#constructor) - -### Properties - -- [axios](SystemtypeApi.md#axios) -- [basePath](SystemtypeApi.md#basepath) -- [configuration](SystemtypeApi.md#configuration) - -### Methods - -- [systemtypeList](SystemtypeApi.md#systemtypelist) -- [systemtypeRetrieve](SystemtypeApi.md#systemtyperetrieve) - -## Constructors - -### constructor - -• **new SystemtypeApi**(`configuration?`, `basePath?`, `axios?`): [`SystemtypeApi`](SystemtypeApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`SystemtypeApi`](SystemtypeApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L49) - -## Methods - -### systemtypeList - -▸ **systemtypeList**(`options?`): `Promise`\<`AxiosResponse`\<[`SystemType`](../interfaces/SystemType.md)[], `any`\>\> - -List all system types by role and product code - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`SystemType`](../interfaces/SystemType.md)[], `any`\>\> - -**`Summary`** - -List all system types - -**`Throws`** - -**`Memberof`** - -SystemtypeApi - -#### Defined in - -[api.ts:9254](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L9254) - -___ - -### systemtypeRetrieve - -▸ **systemtypeRetrieve**(`id`, `options?`): `Promise`\<`AxiosResponse`\<[`SystemType`](../interfaces/SystemType.md), `any`\>\> - -Retrieve details of a single system type - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `number` | A unique integer value identifying this system type. | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`SystemType`](../interfaces/SystemType.md), `any`\>\> - -**`Summary`** - -Retrieve a system type - -**`Throws`** - -**`Memberof`** - -SystemtypeApi - -#### Defined in - -[api.ts:9266](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L9266) diff --git a/packages/insights/doc/classes/TopicApi.md b/packages/insights/doc/classes/TopicApi.md deleted file mode 100644 index 2d4aa9a7b..000000000 --- a/packages/insights/doc/classes/TopicApi.md +++ /dev/null @@ -1,367 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / TopicApi - -# Class: TopicApi - -TopicApi - object-oriented interface - -**`Export`** - -TopicApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`TopicApi`** - -## Table of contents - -### Constructors - -- [constructor](TopicApi.md#constructor) - -### Properties - -- [axios](TopicApi.md#axios) -- [basePath](TopicApi.md#basepath) -- [configuration](TopicApi.md#configuration) - -### Methods - -- [topicCreate](TopicApi.md#topiccreate) -- [topicDestroy](TopicApi.md#topicdestroy) -- [topicList](TopicApi.md#topiclist) -- [topicPartialUpdate](TopicApi.md#topicpartialupdate) -- [topicRetrieve](TopicApi.md#topicretrieve) -- [topicRulesWithTagList](TopicApi.md#topicruleswithtaglist) -- [topicSystemsRetrieve](TopicApi.md#topicsystemsretrieve) -- [topicUpdate](TopicApi.md#topicupdate) - -## Constructors - -### constructor - -• **new TopicApi**(`configuration?`, `basePath?`, `axios?`): [`TopicApi`](TopicApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`TopicApi`](TopicApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L49) - -## Methods - -### topicCreate - -▸ **topicCreate**(`topicEdit`, `options?`): `Promise`\<`AxiosResponse`\<[`TopicEdit`](../interfaces/TopicEdit.md), `any`\>\> - -Create a new rule topic, along with its association to a rule tag - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `topicEdit` | [`TopicEdit`](../interfaces/TopicEdit.md) | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`TopicEdit`](../interfaces/TopicEdit.md), `any`\>\> - -**`Summary`** - -Create a new rule topic - -**`Throws`** - -**`Memberof`** - -TopicApi - -#### Defined in - -[api.ts:9944](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L9944) - -___ - -### topicDestroy - -▸ **topicDestroy**(`slug`, `options?`): `Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -Delete a rule topic. Rules associated with the tag of this topic will be unaffected - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `slug` | `string` | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -**`Summary`** - -Delete a rule topic - -**`Throws`** - -**`Memberof`** - -TopicApi - -#### Defined in - -[api.ts:9956](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L9956) - -___ - -### topicList - -▸ **topicList**(`filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `showDisabled?`, `tags?`, `updateMethod?`, `options?`): `Promise`\<`AxiosResponse`\<[`Topic`](../interfaces/Topic.md)[], `any`\>\> - -List the rule topics and their impacted systems counts. Normally this only shows enabled topics, but if the \'show_disabled\' parameter is set to True then this will show disabled topics as well. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `filterSystemProfileSapSidsContains?` | `string`[] | Are there systems which contain these SAP SIDs? | -| `filterSystemProfileSapSystem?` | `boolean` | Is this a SAP system? | -| `groups?` | `string`[] | List of Inventory host group names | -| `showDisabled?` | `boolean` | Display topics that are disabled as well as enabled | -| `tags?` | `string`[] | Tags have a namespace, key and value in the form namespace/key=value | -| `updateMethod?` | (``"dnfyum"`` \| ``"ostree"``)[] | Search for systems with this updater type | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`Topic`](../interfaces/Topic.md)[], `any`\>\> - -**`Throws`** - -**`Memberof`** - -TopicApi - -#### Defined in - -[api.ts:9972](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L9972) - -___ - -### topicPartialUpdate - -▸ **topicPartialUpdate**(`slug`, `patchedTopicEdit?`, `options?`): `Promise`\<`AxiosResponse`\<[`TopicEdit`](../interfaces/TopicEdit.md), `any`\>\> - -Update an existing rule topic. Only the fields being changed need to be supplied - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `slug` | `string` | | -| `patchedTopicEdit?` | [`PatchedTopicEdit`](../interfaces/PatchedTopicEdit.md) | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`TopicEdit`](../interfaces/TopicEdit.md), `any`\>\> - -**`Summary`** - -Partially update a rule topic - -**`Throws`** - -**`Memberof`** - -TopicApi - -#### Defined in - -[api.ts:9985](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L9985) - -___ - -### topicRetrieve - -▸ **topicRetrieve**(`slug`, `options?`): `Promise`\<`AxiosResponse`\<[`Topic`](../interfaces/Topic.md), `any`\>\> - -Retrieve a single topic by slug. This also lists the topic\'s impacted systems count. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `slug` | `string` | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`Topic`](../interfaces/Topic.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -TopicApi - -#### Defined in - -[api.ts:9996](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L9996) - -___ - -### topicRulesWithTagList - -▸ **topicRulesWithTagList**(`slug`, `options?`): `Promise`\<`AxiosResponse`\<[`Rule`](../interfaces/Rule.md)[], `any`\>\> - -Lists the available rules that have this tag. This shows the rule information for rules with this tag. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `slug` | `string` | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`Rule`](../interfaces/Rule.md)[], `any`\>\> - -**`Throws`** - -**`Memberof`** - -TopicApi - -#### Defined in - -[api.ts:10007](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L10007) - -___ - -### topicSystemsRetrieve - -▸ **topicSystemsRetrieve**(`slug`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `sort?`, `tags?`, `updateMethod?`, `options?`): `Promise`\<`AxiosResponse`\<[`SystemsForRule`](../interfaces/SystemsForRule.md), `any`\>\> - -List all systems affected by this rule topic. Systems are just listed by their UUID. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `slug` | `string` | | -| `filterSystemProfileSapSidsContains?` | `string`[] | Are there systems which contain these SAP SIDs? | -| `filterSystemProfileSapSystem?` | `boolean` | Is this a SAP system? | -| `groups?` | `string`[] | List of Inventory host group names | -| `sort?` | (``"-display_name"`` \| ``"-last_seen"`` \| ``"display_name"`` \| ``"last_seen"`` \| ``"-stale_at"`` \| ``"-system_uuid"`` \| ``"-updated"`` \| ``"stale_at"`` \| ``"system_uuid"`` \| ``"updated"``)[] | Order by this field | -| `tags?` | `string`[] | Tags have a namespace, key and value in the form namespace/key=value | -| `updateMethod?` | (``"dnfyum"`` \| ``"ostree"``)[] | Search for systems with this updater type | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`SystemsForRule`](../interfaces/SystemsForRule.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -TopicApi - -#### Defined in - -[api.ts:10024](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L10024) - -___ - -### topicUpdate - -▸ **topicUpdate**(`slug`, `topicEdit`, `options?`): `Promise`\<`AxiosResponse`\<[`TopicEdit`](../interfaces/TopicEdit.md), `any`\>\> - -Update an existing rule topic. All fields need to be supplied - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `slug` | `string` | | -| `topicEdit` | [`TopicEdit`](../interfaces/TopicEdit.md) | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`TopicEdit`](../interfaces/TopicEdit.md), `any`\>\> - -**`Summary`** - -Update a rule topic - -**`Throws`** - -**`Memberof`** - -TopicApi - -#### Defined in - -[api.ts:10037](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L10037) diff --git a/packages/insights/doc/classes/UsageApi.md b/packages/insights/doc/classes/UsageApi.md deleted file mode 100644 index 3df87e015..000000000 --- a/packages/insights/doc/classes/UsageApi.md +++ /dev/null @@ -1,131 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / UsageApi - -# Class: UsageApi - -UsageApi - object-oriented interface - -**`Export`** - -UsageApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`UsageApi`** - -## Table of contents - -### Constructors - -- [constructor](UsageApi.md#constructor) - -### Properties - -- [axios](UsageApi.md#axios) -- [basePath](UsageApi.md#basepath) -- [configuration](UsageApi.md#configuration) - -### Methods - -- [usageList](UsageApi.md#usagelist) - -## Constructors - -### constructor - -• **new UsageApi**(`configuration?`, `basePath?`, `axios?`): [`UsageApi`](UsageApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`UsageApi`](UsageApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L49) - -## Methods - -### usageList - -▸ **usageList**(`account?`, `end?`, `orgId?`, `start?`, `options?`): `Promise`\<`AxiosResponse`\<[`Usage`](../interfaces/Usage.md), `any`\>\> - -List the unique rule hits for this account over the given time range This uses a HashLogLog structure to record number of hits, and this is therefore an approximation. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `account?` | `string`[] | Allow `hydrauser` to view any account | -| `end?` | `string` | End date for statistics range | -| `orgId?` | `string` | Allow `hydrauser` to view any org_id | -| `start?` | `string` | Start date for statistics range | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`Usage`](../interfaces/Usage.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -UsageApi - -#### Defined in - -[api.ts:10177](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L10177) diff --git a/packages/insights/doc/classes/UserPreferencesApi.md b/packages/insights/doc/classes/UserPreferencesApi.md deleted file mode 100644 index 7bfc98995..000000000 --- a/packages/insights/doc/classes/UserPreferencesApi.md +++ /dev/null @@ -1,157 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / UserPreferencesApi - -# Class: UserPreferencesApi - -UserPreferencesApi - object-oriented interface - -**`Export`** - -UserPreferencesApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`UserPreferencesApi`** - -## Table of contents - -### Constructors - -- [constructor](UserPreferencesApi.md#constructor) - -### Properties - -- [axios](UserPreferencesApi.md#axios) -- [basePath](UserPreferencesApi.md#basepath) -- [configuration](UserPreferencesApi.md#configuration) - -### Methods - -- [userPreferencesCreate](UserPreferencesApi.md#userpreferencescreate) -- [userPreferencesList](UserPreferencesApi.md#userpreferenceslist) - -## Constructors - -### constructor - -• **new UserPreferencesApi**(`configuration?`, `basePath?`, `axios?`): [`UserPreferencesApi`](UserPreferencesApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`UserPreferencesApi`](UserPreferencesApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L49) - -## Methods - -### userPreferencesCreate - -▸ **userPreferencesCreate**(`preferencesInput`, `options?`): `Promise`\<`AxiosResponse`\<[`PreferencesInput`](../interfaces/PreferencesInput.md), `any`\>\> - -Accept the settings as input, and adjust the actual models accordingly. The current account settings will be updated, or one will be created, with the - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `preferencesInput` | [`PreferencesInput`](../interfaces/PreferencesInput.md) | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`PreferencesInput`](../interfaces/PreferencesInput.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -UserPreferencesApi - -#### Defined in - -[api.ts:10350](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L10350) - -___ - -### userPreferencesList - -▸ **userPreferencesList**(`options?`): `Promise`\<`AxiosResponse`\<[`SettingsDDF`](../interfaces/SettingsDDF.md)[], `any`\>\> - -Describe the settings we have in a Data-Driven Forms way. This simply compiles the \'show_satellite_hosts\' account-wide setting and the weekly report \'is_subscribed\' user-specific setting into one handy view, with the description metadata necessary to use Data-Driven Forms to display it. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`SettingsDDF`](../interfaces/SettingsDDF.md)[], `any`\>\> - -**`Throws`** - -**`Memberof`** - -UserPreferencesApi - -#### Defined in - -[api.ts:10360](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L10360) diff --git a/packages/insights/doc/classes/WeeklyreportautosubscribeApi.md b/packages/insights/doc/classes/WeeklyreportautosubscribeApi.md deleted file mode 100644 index ccafa0d0c..000000000 --- a/packages/insights/doc/classes/WeeklyreportautosubscribeApi.md +++ /dev/null @@ -1,157 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / WeeklyreportautosubscribeApi - -# Class: WeeklyreportautosubscribeApi - -WeeklyreportautosubscribeApi - object-oriented interface - -**`Export`** - -WeeklyreportautosubscribeApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`WeeklyreportautosubscribeApi`** - -## Table of contents - -### Constructors - -- [constructor](WeeklyreportautosubscribeApi.md#constructor) - -### Properties - -- [axios](WeeklyreportautosubscribeApi.md#axios) -- [basePath](WeeklyreportautosubscribeApi.md#basepath) -- [configuration](WeeklyreportautosubscribeApi.md#configuration) - -### Methods - -- [weeklyreportautosubscribeCreate](WeeklyreportautosubscribeApi.md#weeklyreportautosubscribecreate) -- [weeklyreportautosubscribeList](WeeklyreportautosubscribeApi.md#weeklyreportautosubscribelist) - -## Constructors - -### constructor - -• **new WeeklyreportautosubscribeApi**(`configuration?`, `basePath?`, `axios?`): [`WeeklyreportautosubscribeApi`](WeeklyreportautosubscribeApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`WeeklyreportautosubscribeApi`](WeeklyreportautosubscribeApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L49) - -## Methods - -### weeklyreportautosubscribeCreate - -▸ **weeklyreportautosubscribeCreate**(`autoSubscribeInput`, `options?`): `Promise`\<`AxiosResponse`\<[`AutoSubscribe`](../interfaces/AutoSubscribe.md), `any`\>\> - -Set the auto-subscription status of the current user to the supplied `is_auto_subscribed` value. If \'is_auto_subscribed\' is true, an auto-subscription is added if it doesn\'t already exist. If it is false, the auto-subscription is removed if it exists. Check if ENABLE_AUTOSUB enviroment variable is set to allow the method. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `autoSubscribeInput` | [`AutoSubscribeInput`](../interfaces/AutoSubscribeInput.md) | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`AutoSubscribe`](../interfaces/AutoSubscribe.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -WeeklyreportautosubscribeApi - -#### Defined in - -[api.ts:10533](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L10533) - -___ - -### weeklyreportautosubscribeList - -▸ **weeklyreportautosubscribeList**(`options?`): `Promise`\<`AxiosResponse`\<[`AutoSubscribe`](../interfaces/AutoSubscribe.md)[], `any`\>\> - -Show the user\'s current subscription status. This shows the presence of a weekly report subscription by the user in this account. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`AutoSubscribe`](../interfaces/AutoSubscribe.md)[], `any`\>\> - -**`Throws`** - -**`Memberof`** - -WeeklyreportautosubscribeApi - -#### Defined in - -[api.ts:10543](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L10543) diff --git a/packages/insights/doc/classes/WeeklyreportsubscriptionApi.md b/packages/insights/doc/classes/WeeklyreportsubscriptionApi.md deleted file mode 100644 index 35fb86d41..000000000 --- a/packages/insights/doc/classes/WeeklyreportsubscriptionApi.md +++ /dev/null @@ -1,157 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / WeeklyreportsubscriptionApi - -# Class: WeeklyreportsubscriptionApi - -WeeklyreportsubscriptionApi - object-oriented interface - -**`Export`** - -WeeklyreportsubscriptionApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`WeeklyreportsubscriptionApi`** - -## Table of contents - -### Constructors - -- [constructor](WeeklyreportsubscriptionApi.md#constructor) - -### Properties - -- [axios](WeeklyreportsubscriptionApi.md#axios) -- [basePath](WeeklyreportsubscriptionApi.md#basepath) -- [configuration](WeeklyreportsubscriptionApi.md#configuration) - -### Methods - -- [weeklyreportsubscriptionCreate](WeeklyreportsubscriptionApi.md#weeklyreportsubscriptioncreate) -- [weeklyreportsubscriptionList](WeeklyreportsubscriptionApi.md#weeklyreportsubscriptionlist) - -## Constructors - -### constructor - -• **new WeeklyreportsubscriptionApi**(`configuration?`, `basePath?`, `axios?`): [`WeeklyreportsubscriptionApi`](WeeklyreportsubscriptionApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`WeeklyreportsubscriptionApi`](WeeklyreportsubscriptionApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/base.ts#L49) - -## Methods - -### weeklyreportsubscriptionCreate - -▸ **weeklyreportsubscriptionCreate**(`weeklyReportSubscription`, `options?`): `Promise`\<`AxiosResponse`\<[`WeeklyReportSubscription`](../interfaces/WeeklyReportSubscription.md), `any`\>\> - -Set the subscription status of the current user to the supplied `is_subscribed` value. If \'is_subscribed\' is true, a subscription is added if it doesn\'t already exist. If it is false, the subscription is removed if it exists. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `weeklyReportSubscription` | [`WeeklyReportSubscription`](../interfaces/WeeklyReportSubscription.md) | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`WeeklyReportSubscription`](../interfaces/WeeklyReportSubscription.md), `any`\>\> - -**`Throws`** - -**`Memberof`** - -WeeklyreportsubscriptionApi - -#### Defined in - -[api.ts:10716](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L10716) - -___ - -### weeklyreportsubscriptionList - -▸ **weeklyreportsubscriptionList**(`options?`): `Promise`\<`AxiosResponse`\<[`WeeklyReportSubscription`](../interfaces/WeeklyReportSubscription.md)[], `any`\>\> - -Show the user\'s current subscription status. This shows the presence of a weekly report subscription by the user in this account. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`WeeklyReportSubscription`](../interfaces/WeeklyReportSubscription.md)[], `any`\>\> - -**`Throws`** - -**`Memberof`** - -WeeklyreportsubscriptionApi - -#### Defined in - -[api.ts:10726](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L10726) diff --git a/packages/insights/doc/enums/AllRuleRatingsRatingEnum.md b/packages/insights/doc/enums/AllRuleRatingsRatingEnum.md deleted file mode 100644 index 689ce537d..000000000 --- a/packages/insights/doc/enums/AllRuleRatingsRatingEnum.md +++ /dev/null @@ -1,43 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / AllRuleRatingsRatingEnum - -# Enumeration: AllRuleRatingsRatingEnum - -**`Export`** - -## Table of contents - -### Enumeration Members - -- [NUMBER\_0](AllRuleRatingsRatingEnum.md#number_0) -- [NUMBER\_1](AllRuleRatingsRatingEnum.md#number_1) -- [NUMBER\_MINUS\_1](AllRuleRatingsRatingEnum.md#number_minus_1) - -## Enumeration Members - -### NUMBER\_0 - -• **NUMBER\_0** = ``0`` - -#### Defined in - -[api.ts:215](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L215) - -___ - -### NUMBER\_1 - -• **NUMBER\_1** = ``1`` - -#### Defined in - -[api.ts:216](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L216) - -___ - -### NUMBER\_MINUS\_1 - -• **NUMBER\_MINUS\_1** = ``-1`` - -#### Defined in - -[api.ts:214](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L214) diff --git a/packages/insights/doc/enums/RuleRatingRatingEnum.md b/packages/insights/doc/enums/RuleRatingRatingEnum.md deleted file mode 100644 index 6324ada30..000000000 --- a/packages/insights/doc/enums/RuleRatingRatingEnum.md +++ /dev/null @@ -1,43 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / RuleRatingRatingEnum - -# Enumeration: RuleRatingRatingEnum - -**`Export`** - -## Table of contents - -### Enumeration Members - -- [NUMBER\_0](RuleRatingRatingEnum.md#number_0) -- [NUMBER\_1](RuleRatingRatingEnum.md#number_1) -- [NUMBER\_MINUS\_1](RuleRatingRatingEnum.md#number_minus_1) - -## Enumeration Members - -### NUMBER\_0 - -• **NUMBER\_0** = ``0`` - -#### Defined in - -[api.ts:1774](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1774) - -___ - -### NUMBER\_1 - -• **NUMBER\_1** = ``1`` - -#### Defined in - -[api.ts:1775](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1775) - -___ - -### NUMBER\_MINUS\_1 - -• **NUMBER\_MINUS\_1** = ``-1`` - -#### Defined in - -[api.ts:1773](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1773) diff --git a/packages/insights/doc/interfaces/Ack.md b/packages/insights/doc/interfaces/Ack.md deleted file mode 100644 index cc8acc194..000000000 --- a/packages/insights/doc/interfaces/Ack.md +++ /dev/null @@ -1,91 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / Ack - -# Interface: Ack - -**`Export`** - -Ack - -## Table of contents - -### Properties - -- [created\_at](Ack.md#created_at) -- [created\_by](Ack.md#created_by) -- [justification](Ack.md#justification) -- [rule](Ack.md#rule) -- [updated\_at](Ack.md#updated_at) - -## Properties - -### created\_at - -• **created\_at**: `string` - -**`Memberof`** - -Ack - -#### Defined in - -[api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L51) - -___ - -### created\_by - -• `Optional` **created\_by**: `string` - -The user who created the ack - -**`Memberof`** - -Ack - -#### Defined in - -[api.ts:45](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L45) - -___ - -### justification - -• `Optional` **justification**: `string` - -The reason the rule was acked - -**`Memberof`** - -Ack - -#### Defined in - -[api.ts:39](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L39) - -___ - -### rule - -• **rule**: `string` - -**`Memberof`** - -Ack - -#### Defined in - -[api.ts:33](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L33) - -___ - -### updated\_at - -• **updated\_at**: `string` - -**`Memberof`** - -Ack - -#### Defined in - -[api.ts:57](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L57) diff --git a/packages/insights/doc/interfaces/AckCount.md b/packages/insights/doc/interfaces/AckCount.md deleted file mode 100644 index e9e8af46d..000000000 --- a/packages/insights/doc/interfaces/AckCount.md +++ /dev/null @@ -1,44 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / AckCount - -# Interface: AckCount - -A rule_id and the number of acks on it - -**`Export`** - -AckCount - -## Table of contents - -### Properties - -- [ack\_count](AckCount.md#ack_count) -- [rule\_id](AckCount.md#rule_id) - -## Properties - -### ack\_count - -• **ack\_count**: `number` - -**`Memberof`** - -AckCount - -#### Defined in - -[api.ts:76](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L76) - -___ - -### rule\_id - -• **rule\_id**: `string` - -**`Memberof`** - -AckCount - -#### Defined in - -[api.ts:70](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L70) diff --git a/packages/insights/doc/interfaces/AckInput.md b/packages/insights/doc/interfaces/AckInput.md deleted file mode 100644 index f0cf75682..000000000 --- a/packages/insights/doc/interfaces/AckInput.md +++ /dev/null @@ -1,42 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / AckInput - -# Interface: AckInput - -**`Export`** - -AckInput - -## Table of contents - -### Properties - -- [justification](AckInput.md#justification) -- [rule\_id](AckInput.md#rule_id) - -## Properties - -### justification - -• `Optional` **justification**: `string` - -**`Memberof`** - -AckInput - -#### Defined in - -[api.ts:95](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L95) - -___ - -### rule\_id - -• **rule\_id**: `string` - -**`Memberof`** - -AckInput - -#### Defined in - -[api.ts:89](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L89) diff --git a/packages/insights/doc/interfaces/AckJustification.md b/packages/insights/doc/interfaces/AckJustification.md deleted file mode 100644 index 8e757d93b..000000000 --- a/packages/insights/doc/interfaces/AckJustification.md +++ /dev/null @@ -1,29 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / AckJustification - -# Interface: AckJustification - -**`Export`** - -AckJustification - -## Table of contents - -### Properties - -- [justification](AckJustification.md#justification) - -## Properties - -### justification - -• `Optional` **justification**: `string` - -The reason the rule was acked - -**`Memberof`** - -AckJustification - -#### Defined in - -[api.ts:108](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L108) diff --git a/packages/insights/doc/interfaces/AllAck.md b/packages/insights/doc/interfaces/AllAck.md deleted file mode 100644 index 3699b2aca..000000000 --- a/packages/insights/doc/interfaces/AllAck.md +++ /dev/null @@ -1,121 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / AllAck - -# Interface: AllAck - -**`Export`** - -AllAck - -## Table of contents - -### Properties - -- [account](AllAck.md#account) -- [created\_at](AllAck.md#created_at) -- [created\_by](AllAck.md#created_by) -- [justification](AllAck.md#justification) -- [org\_id](AllAck.md#org_id) -- [rule](AllAck.md#rule) -- [updated\_at](AllAck.md#updated_at) - -## Properties - -### account - -• **account**: `string` - -**`Memberof`** - -AllAck - -#### Defined in - -[api.ts:121](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L121) - -___ - -### created\_at - -• **created\_at**: `string` - -**`Memberof`** - -AllAck - -#### Defined in - -[api.ts:151](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L151) - -___ - -### created\_by - -• `Optional` **created\_by**: `string` - -The user who created the ack - -**`Memberof`** - -AllAck - -#### Defined in - -[api.ts:145](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L145) - -___ - -### justification - -• `Optional` **justification**: `string` - -The reason the rule was acked - -**`Memberof`** - -AllAck - -#### Defined in - -[api.ts:139](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L139) - -___ - -### org\_id - -• **org\_id**: `string` - -**`Memberof`** - -AllAck - -#### Defined in - -[api.ts:127](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L127) - -___ - -### rule - -• **rule**: `string` - -**`Memberof`** - -AllAck - -#### Defined in - -[api.ts:133](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L133) - -___ - -### updated\_at - -• **updated\_at**: `string` - -**`Memberof`** - -AllAck - -#### Defined in - -[api.ts:157](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L157) diff --git a/packages/insights/doc/interfaces/AllRuleRatings.md b/packages/insights/doc/interfaces/AllRuleRatings.md deleted file mode 100644 index d15a7516a..000000000 --- a/packages/insights/doc/interfaces/AllRuleRatings.md +++ /dev/null @@ -1,125 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / AllRuleRatings - -# Interface: AllRuleRatings - -This is only available to internal users and lists ratings from all users. - -**`Export`** - -AllRuleRatings - -## Table of contents - -### Properties - -- [account](AllRuleRatings.md#account) -- [created\_at](AllRuleRatings.md#created_at) -- [org\_id](AllRuleRatings.md#org_id) -- [rated\_by](AllRuleRatings.md#rated_by) -- [rating](AllRuleRatings.md#rating) -- [rule](AllRuleRatings.md#rule) -- [updated\_at](AllRuleRatings.md#updated_at) - -## Properties - -### account - -• `Optional` **account**: ``null`` \| `string` - -**`Memberof`** - -AllRuleRatings - -#### Defined in - -[api.ts:200](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L200) - -___ - -### created\_at - -• **created\_at**: `string` - -**`Memberof`** - -AllRuleRatings - -#### Defined in - -[api.ts:182](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L182) - -___ - -### org\_id - -• **org\_id**: `string` - -**`Memberof`** - -AllRuleRatings - -#### Defined in - -[api.ts:206](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L206) - -___ - -### rated\_by - -• `Optional` **rated\_by**: `string` - -The username that rated this rule - -**`Memberof`** - -AllRuleRatings - -#### Defined in - -[api.ts:194](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L194) - -___ - -### rating - -• **rating**: [`AllRuleRatingsRatingEnum`](../enums/AllRuleRatingsRatingEnum.md) - -* `-1` - Dislike * `0` - Neutral * `1` - Like - -**`Memberof`** - -AllRuleRatings - -#### Defined in - -[api.ts:176](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L176) - -___ - -### rule - -• **rule**: `string` - -Rule ID from Insights - -**`Memberof`** - -AllRuleRatings - -#### Defined in - -[api.ts:170](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L170) - -___ - -### updated\_at - -• **updated\_at**: `string` - -**`Memberof`** - -AllRuleRatings - -#### Defined in - -[api.ts:188](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L188) diff --git a/packages/insights/doc/interfaces/AutoSubscribe.md b/packages/insights/doc/interfaces/AutoSubscribe.md deleted file mode 100644 index ac5029531..000000000 --- a/packages/insights/doc/interfaces/AutoSubscribe.md +++ /dev/null @@ -1,44 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / AutoSubscribe - -# Interface: AutoSubscribe - -Serializer specifically for listing all Pathways currently in the system - -**`Export`** - -AutoSubscribe - -## Table of contents - -### Properties - -- [is\_auto\_subscribed](AutoSubscribe.md#is_auto_subscribed) -- [org\_id](AutoSubscribe.md#org_id) - -## Properties - -### is\_auto\_subscribed - -• **is\_auto\_subscribed**: `boolean` - -**`Memberof`** - -AutoSubscribe - -#### Defined in - -[api.ts:236](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L236) - -___ - -### org\_id - -• **org\_id**: `string` - -**`Memberof`** - -AutoSubscribe - -#### Defined in - -[api.ts:230](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L230) diff --git a/packages/insights/doc/interfaces/AutoSubscribeInput.md b/packages/insights/doc/interfaces/AutoSubscribeInput.md deleted file mode 100644 index 27d2f1c39..000000000 --- a/packages/insights/doc/interfaces/AutoSubscribeInput.md +++ /dev/null @@ -1,44 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / AutoSubscribeInput - -# Interface: AutoSubscribeInput - -Serializer specifically for handling CREATE and UPDATE views for AutoSubscribe - -**`Export`** - -AutoSubscribeInput - -## Table of contents - -### Properties - -- [is\_auto\_subscribed](AutoSubscribeInput.md#is_auto_subscribed) -- [org\_id](AutoSubscribeInput.md#org_id) - -## Properties - -### is\_auto\_subscribed - -• **is\_auto\_subscribed**: `boolean` - -**`Memberof`** - -AutoSubscribeInput - -#### Defined in - -[api.ts:255](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L255) - -___ - -### org\_id - -• **org\_id**: `string` - -**`Memberof`** - -AutoSubscribeInput - -#### Defined in - -[api.ts:249](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L249) diff --git a/packages/insights/doc/interfaces/ConfigurationParameters.md b/packages/insights/doc/interfaces/ConfigurationParameters.md deleted file mode 100644 index ed43bb3ab..000000000 --- a/packages/insights/doc/interfaces/ConfigurationParameters.md +++ /dev/null @@ -1,83 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / ConfigurationParameters - -# Interface: ConfigurationParameters - -Insights Advisor API -The API of the Advisor project in Insights - -The version of the OpenAPI document: 1.0.0 - -NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -https://openapi-generator.tech -Do not edit the class manually. - -## Table of contents - -### Properties - -- [accessToken](ConfigurationParameters.md#accesstoken) -- [apiKey](ConfigurationParameters.md#apikey) -- [baseOptions](ConfigurationParameters.md#baseoptions) -- [basePath](ConfigurationParameters.md#basepath) -- [password](ConfigurationParameters.md#password) -- [username](ConfigurationParameters.md#username) - -## Properties - -### accessToken - -• `Optional` **accessToken**: `string` \| (`name?`: `string`, `scopes?`: `string`[]) => `string` - -#### Defined in - -[configuration.ts:19](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/configuration.ts#L19) - -___ - -### apiKey - -• `Optional` **apiKey**: `string` \| `Promise`\<`string`\> \| (`name`: `string`) => `string` \| (`name`: `string`) => `Promise`\<`string`\> - -#### Defined in - -[configuration.ts:16](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/configuration.ts#L16) - -___ - -### baseOptions - -• `Optional` **baseOptions**: `any` - -#### Defined in - -[configuration.ts:21](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/configuration.ts#L21) - -___ - -### basePath - -• `Optional` **basePath**: `string` - -#### Defined in - -[configuration.ts:20](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/configuration.ts#L20) - -___ - -### password - -• `Optional` **password**: `string` - -#### Defined in - -[configuration.ts:18](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/configuration.ts#L18) - -___ - -### username - -• `Optional` **username**: `string` - -#### Defined in - -[configuration.ts:17](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/configuration.ts#L17) diff --git a/packages/insights/doc/interfaces/ExportHits.md b/packages/insights/doc/interfaces/ExportHits.md deleted file mode 100644 index 6c63dda73..000000000 --- a/packages/insights/doc/interfaces/ExportHits.md +++ /dev/null @@ -1,179 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / ExportHits - -# Interface: ExportHits - -The basic report information for each system affected by a rule. Only lists basic details of the host and rule, and links to more information. - -**`Export`** - -ExportHits - -## Table of contents - -### Properties - -- [hostname](ExportHits.md#hostname) -- [last\_seen](ExportHits.md#last_seen) -- [likelihood](ExportHits.md#likelihood) -- [publish\_date](ExportHits.md#publish_date) -- [results\_url](ExportHits.md#results_url) -- [rhel\_version](ExportHits.md#rhel_version) -- [solution\_url](ExportHits.md#solution_url) -- [stale\_at](ExportHits.md#stale_at) -- [title](ExportHits.md#title) -- [total\_risk](ExportHits.md#total_risk) -- [uuid](ExportHits.md#uuid) - -## Properties - -### hostname - -• **hostname**: `string` - -**`Memberof`** - -ExportHits - -#### Defined in - -[api.ts:268](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L268) - -___ - -### last\_seen - -• **last\_seen**: `string` - -**`Memberof`** - -ExportHits - -#### Defined in - -[api.ts:286](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L286) - -___ - -### likelihood - -• **likelihood**: `number` - -**`Memberof`** - -ExportHits - -#### Defined in - -[api.ts:310](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L310) - -___ - -### publish\_date - -• **publish\_date**: `string` - -**`Memberof`** - -ExportHits - -#### Defined in - -[api.ts:316](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L316) - -___ - -### results\_url - -• **results\_url**: `string` - -**`Memberof`** - -ExportHits - -#### Defined in - -[api.ts:328](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L328) - -___ - -### rhel\_version - -• **rhel\_version**: `string` - -**`Memberof`** - -ExportHits - -#### Defined in - -[api.ts:274](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L274) - -___ - -### solution\_url - -• **solution\_url**: `string` - -**`Memberof`** - -ExportHits - -#### Defined in - -[api.ts:298](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L298) - -___ - -### stale\_at - -• **stale\_at**: `string` - -**`Memberof`** - -ExportHits - -#### Defined in - -[api.ts:322](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L322) - -___ - -### title - -• **title**: `string` - -**`Memberof`** - -ExportHits - -#### Defined in - -[api.ts:292](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L292) - -___ - -### total\_risk - -• **total\_risk**: `number` - -**`Memberof`** - -ExportHits - -#### Defined in - -[api.ts:304](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L304) - -___ - -### uuid - -• **uuid**: `string` - -**`Memberof`** - -ExportHits - -#### Defined in - -[api.ts:280](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L280) diff --git a/packages/insights/doc/interfaces/HostAck.md b/packages/insights/doc/interfaces/HostAck.md deleted file mode 100644 index 31d02ff4d..000000000 --- a/packages/insights/doc/interfaces/HostAck.md +++ /dev/null @@ -1,138 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / HostAck - -# Interface: HostAck - -Ignore reports of this rule on this system for this account. - -**`Export`** - -HostAck - -## Table of contents - -### Properties - -- [created\_at](HostAck.md#created_at) -- [created\_by](HostAck.md#created_by) -- [display\_name](HostAck.md#display_name) -- [id](HostAck.md#id) -- [justification](HostAck.md#justification) -- [rule](HostAck.md#rule) -- [system\_uuid](HostAck.md#system_uuid) -- [updated\_at](HostAck.md#updated_at) - -## Properties - -### created\_at - -• **created\_at**: `string` - -**`Memberof`** - -HostAck - -#### Defined in - -[api.ts:371](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L371) - -___ - -### created\_by - -• **created\_by**: `string` - -The username that created this acknowledgement - -**`Memberof`** - -HostAck - -#### Defined in - -[api.ts:365](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L365) - -___ - -### display\_name - -• **display\_name**: `string` - -**`Memberof`** - -HostAck - -#### Defined in - -[api.ts:383](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L383) - -___ - -### id - -• **id**: `number` - -**`Memberof`** - -HostAck - -#### Defined in - -[api.ts:341](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L341) - -___ - -### justification - -• `Optional` **justification**: `string` - -**`Memberof`** - -HostAck - -#### Defined in - -[api.ts:359](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L359) - -___ - -### rule - -• **rule**: `string` - -Rule ID from Insights - -**`Memberof`** - -HostAck - -#### Defined in - -[api.ts:347](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L347) - -___ - -### system\_uuid - -• **system\_uuid**: `string` - -**`Memberof`** - -HostAck - -#### Defined in - -[api.ts:353](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L353) - -___ - -### updated\_at - -• **updated\_at**: `string` - -**`Memberof`** - -HostAck - -#### Defined in - -[api.ts:377](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L377) diff --git a/packages/insights/doc/interfaces/HostAckInput.md b/packages/insights/doc/interfaces/HostAckInput.md deleted file mode 100644 index 7b2c1b481..000000000 --- a/packages/insights/doc/interfaces/HostAckInput.md +++ /dev/null @@ -1,61 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / HostAckInput - -# Interface: HostAckInput - -Ignore reports of this rule on this system for this account. Use this when creating a new HostAck. - -**`Export`** - -HostAckInput - -## Table of contents - -### Properties - -- [justification](HostAckInput.md#justification) -- [rule](HostAckInput.md#rule) -- [system\_uuid](HostAckInput.md#system_uuid) - -## Properties - -### justification - -• `Optional` **justification**: `string` - -**`Memberof`** - -HostAckInput - -#### Defined in - -[api.ts:408](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L408) - -___ - -### rule - -• **rule**: `string` - -Rule ID from Insights - -**`Memberof`** - -HostAckInput - -#### Defined in - -[api.ts:396](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L396) - -___ - -### system\_uuid - -• **system\_uuid**: `string` - -**`Memberof`** - -HostAckInput - -#### Defined in - -[api.ts:402](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L402) diff --git a/packages/insights/doc/interfaces/HostAckJustification.md b/packages/insights/doc/interfaces/HostAckJustification.md deleted file mode 100644 index 31c75b8a2..000000000 --- a/packages/insights/doc/interfaces/HostAckJustification.md +++ /dev/null @@ -1,44 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / HostAckJustification - -# Interface: HostAckJustification - -Just modify the justification on a Host Ack. - -**`Export`** - -HostAckJustification - -## Table of contents - -### Properties - -- [id](HostAckJustification.md#id) -- [justification](HostAckJustification.md#justification) - -## Properties - -### id - -• **id**: `number` - -**`Memberof`** - -HostAckJustification - -#### Defined in - -[api.ts:421](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L421) - -___ - -### justification - -• `Optional` **justification**: `string` - -**`Memberof`** - -HostAckJustification - -#### Defined in - -[api.ts:427](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L427) diff --git a/packages/insights/doc/interfaces/JustificationCount.md b/packages/insights/doc/interfaces/JustificationCount.md deleted file mode 100644 index 645bed706..000000000 --- a/packages/insights/doc/interfaces/JustificationCount.md +++ /dev/null @@ -1,42 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / JustificationCount - -# Interface: JustificationCount - -**`Export`** - -JustificationCount - -## Table of contents - -### Properties - -- [count](JustificationCount.md#count) -- [justification](JustificationCount.md#justification) - -## Properties - -### count - -• **count**: `number` - -**`Memberof`** - -JustificationCount - -#### Defined in - -[api.ts:446](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L446) - -___ - -### justification - -• **justification**: `string` - -**`Memberof`** - -JustificationCount - -#### Defined in - -[api.ts:440](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L440) diff --git a/packages/insights/doc/interfaces/Kcs.md b/packages/insights/doc/interfaces/Kcs.md deleted file mode 100644 index 9c1970a4b..000000000 --- a/packages/insights/doc/interfaces/Kcs.md +++ /dev/null @@ -1,48 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / Kcs - -# Interface: Kcs - -Pairings of C.R.C rule URL and its KCS solution number (node_id) - -**`Export`** - -Kcs - -## Table of contents - -### Properties - -- [node\_id](Kcs.md#node_id) -- [rule\_url](Kcs.md#rule_url) - -## Properties - -### node\_id - -• **node\_id**: `string` - -KCS solution number - -**`Memberof`** - -Kcs - -#### Defined in - -[api.ts:465](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L465) - -___ - -### rule\_url - -• **rule\_url**: `string` - -Rule URL on C.R.C. - -**`Memberof`** - -Kcs - -#### Defined in - -[api.ts:459](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L459) diff --git a/packages/insights/doc/interfaces/MultiAckResponse.md b/packages/insights/doc/interfaces/MultiAckResponse.md deleted file mode 100644 index 27a41a96e..000000000 --- a/packages/insights/doc/interfaces/MultiAckResponse.md +++ /dev/null @@ -1,44 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / MultiAckResponse - -# Interface: MultiAckResponse - -The response from adding or deleting multiple acks on a rule. For backward compatibility we include the count, and then list the impacted systems. - -**`Export`** - -MultiAckResponse - -## Table of contents - -### Properties - -- [count](MultiAckResponse.md#count) -- [host\_ids](MultiAckResponse.md#host_ids) - -## Properties - -### count - -• **count**: `number` - -**`Memberof`** - -MultiAckResponse - -#### Defined in - -[api.ts:478](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L478) - -___ - -### host\_ids - -• **host\_ids**: `string`[] - -**`Memberof`** - -MultiAckResponse - -#### Defined in - -[api.ts:484](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L484) diff --git a/packages/insights/doc/interfaces/MultiHostAck.md b/packages/insights/doc/interfaces/MultiHostAck.md deleted file mode 100644 index d88c18be5..000000000 --- a/packages/insights/doc/interfaces/MultiHostAck.md +++ /dev/null @@ -1,44 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / MultiHostAck - -# Interface: MultiHostAck - -Add acks to multiple hosts for a single rule. - -**`Export`** - -MultiHostAck - -## Table of contents - -### Properties - -- [justification](MultiHostAck.md#justification) -- [systems](MultiHostAck.md#systems) - -## Properties - -### justification - -• **justification**: `string` - -**`Memberof`** - -MultiHostAck - -#### Defined in - -[api.ts:503](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L503) - -___ - -### systems - -• **systems**: `string`[] - -**`Memberof`** - -MultiHostAck - -#### Defined in - -[api.ts:497](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L497) diff --git a/packages/insights/doc/interfaces/MultiHostUnAck.md b/packages/insights/doc/interfaces/MultiHostUnAck.md deleted file mode 100644 index e93bb1bf8..000000000 --- a/packages/insights/doc/interfaces/MultiHostUnAck.md +++ /dev/null @@ -1,29 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / MultiHostUnAck - -# Interface: MultiHostUnAck - -Delete acks from multiple hosts for a single rule. - -**`Export`** - -MultiHostUnAck - -## Table of contents - -### Properties - -- [systems](MultiHostUnAck.md#systems) - -## Properties - -### systems - -• **systems**: `string`[] - -**`Memberof`** - -MultiHostUnAck - -#### Defined in - -[api.ts:516](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L516) diff --git a/packages/insights/doc/interfaces/OrgId.md b/packages/insights/doc/interfaces/OrgId.md deleted file mode 100644 index 9ee6899d4..000000000 --- a/packages/insights/doc/interfaces/OrgId.md +++ /dev/null @@ -1,29 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / OrgId - -# Interface: OrgId - -A specific org id for a Red Hat customer. - -**`Export`** - -OrgId - -## Table of contents - -### Properties - -- [org\_id](OrgId.md#org_id) - -## Properties - -### org\_id - -• **org\_id**: `string` - -**`Memberof`** - -OrgId - -#### Defined in - -[api.ts:529](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L529) diff --git a/packages/insights/doc/interfaces/PaginatedAckList.md b/packages/insights/doc/interfaces/PaginatedAckList.md deleted file mode 100644 index 9886be280..000000000 --- a/packages/insights/doc/interfaces/PaginatedAckList.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / PaginatedAckList - -# Interface: PaginatedAckList - -**`Export`** - -PaginatedAckList - -## Table of contents - -### Properties - -- [data](PaginatedAckList.md#data) -- [links](PaginatedAckList.md#links) -- [meta](PaginatedAckList.md#meta) - -## Properties - -### data - -• `Optional` **data**: [`Ack`](Ack.md)[] - -**`Memberof`** - -PaginatedAckList - -#### Defined in - -[api.ts:554](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L554) - -___ - -### links - -• `Optional` **links**: [`PaginatedAckListLinks`](PaginatedAckListLinks.md) - -**`Memberof`** - -PaginatedAckList - -#### Defined in - -[api.ts:548](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L548) - -___ - -### meta - -• `Optional` **meta**: [`PaginatedAckListMeta`](PaginatedAckListMeta.md) - -**`Memberof`** - -PaginatedAckList - -#### Defined in - -[api.ts:542](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L542) diff --git a/packages/insights/doc/interfaces/PaginatedAckListLinks.md b/packages/insights/doc/interfaces/PaginatedAckListLinks.md deleted file mode 100644 index 7990751a8..000000000 --- a/packages/insights/doc/interfaces/PaginatedAckListLinks.md +++ /dev/null @@ -1,72 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / PaginatedAckListLinks - -# Interface: PaginatedAckListLinks - -**`Export`** - -PaginatedAckListLinks - -## Table of contents - -### Properties - -- [first](PaginatedAckListLinks.md#first) -- [last](PaginatedAckListLinks.md#last) -- [next](PaginatedAckListLinks.md#next) -- [previous](PaginatedAckListLinks.md#previous) - -## Properties - -### first - -• `Optional` **first**: ``null`` \| `string` - -**`Memberof`** - -PaginatedAckListLinks - -#### Defined in - -[api.ts:567](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L567) - -___ - -### last - -• `Optional` **last**: ``null`` \| `string` - -**`Memberof`** - -PaginatedAckListLinks - -#### Defined in - -[api.ts:585](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L585) - -___ - -### next - -• `Optional` **next**: ``null`` \| `string` - -**`Memberof`** - -PaginatedAckListLinks - -#### Defined in - -[api.ts:579](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L579) - -___ - -### previous - -• `Optional` **previous**: ``null`` \| `string` - -**`Memberof`** - -PaginatedAckListLinks - -#### Defined in - -[api.ts:573](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L573) diff --git a/packages/insights/doc/interfaces/PaginatedAckListMeta.md b/packages/insights/doc/interfaces/PaginatedAckListMeta.md deleted file mode 100644 index 872cfca84..000000000 --- a/packages/insights/doc/interfaces/PaginatedAckListMeta.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / PaginatedAckListMeta - -# Interface: PaginatedAckListMeta - -**`Export`** - -PaginatedAckListMeta - -## Table of contents - -### Properties - -- [count](PaginatedAckListMeta.md#count) - -## Properties - -### count - -• **count**: `number` - -**`Memberof`** - -PaginatedAckListMeta - -#### Defined in - -[api.ts:598](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L598) diff --git a/packages/insights/doc/interfaces/PaginatedAllRuleRatingsList.md b/packages/insights/doc/interfaces/PaginatedAllRuleRatingsList.md deleted file mode 100644 index 50252c659..000000000 --- a/packages/insights/doc/interfaces/PaginatedAllRuleRatingsList.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / PaginatedAllRuleRatingsList - -# Interface: PaginatedAllRuleRatingsList - -**`Export`** - -PaginatedAllRuleRatingsList - -## Table of contents - -### Properties - -- [data](PaginatedAllRuleRatingsList.md#data) -- [links](PaginatedAllRuleRatingsList.md#links) -- [meta](PaginatedAllRuleRatingsList.md#meta) - -## Properties - -### data - -• `Optional` **data**: [`AllRuleRatings`](AllRuleRatings.md)[] - -**`Memberof`** - -PaginatedAllRuleRatingsList - -#### Defined in - -[api.ts:623](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L623) - -___ - -### links - -• `Optional` **links**: [`PaginatedAckListLinks`](PaginatedAckListLinks.md) - -**`Memberof`** - -PaginatedAllRuleRatingsList - -#### Defined in - -[api.ts:617](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L617) - -___ - -### meta - -• `Optional` **meta**: [`PaginatedAckListMeta`](PaginatedAckListMeta.md) - -**`Memberof`** - -PaginatedAllRuleRatingsList - -#### Defined in - -[api.ts:611](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L611) diff --git a/packages/insights/doc/interfaces/PaginatedHostAckList.md b/packages/insights/doc/interfaces/PaginatedHostAckList.md deleted file mode 100644 index 35ce7258a..000000000 --- a/packages/insights/doc/interfaces/PaginatedHostAckList.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / PaginatedHostAckList - -# Interface: PaginatedHostAckList - -**`Export`** - -PaginatedHostAckList - -## Table of contents - -### Properties - -- [data](PaginatedHostAckList.md#data) -- [links](PaginatedHostAckList.md#links) -- [meta](PaginatedHostAckList.md#meta) - -## Properties - -### data - -• `Optional` **data**: [`HostAck`](HostAck.md)[] - -**`Memberof`** - -PaginatedHostAckList - -#### Defined in - -[api.ts:648](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L648) - -___ - -### links - -• `Optional` **links**: [`PaginatedAckListLinks`](PaginatedAckListLinks.md) - -**`Memberof`** - -PaginatedHostAckList - -#### Defined in - -[api.ts:642](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L642) - -___ - -### meta - -• `Optional` **meta**: [`PaginatedAckListMeta`](PaginatedAckListMeta.md) - -**`Memberof`** - -PaginatedHostAckList - -#### Defined in - -[api.ts:636](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L636) diff --git a/packages/insights/doc/interfaces/PaginatedJustificationCountList.md b/packages/insights/doc/interfaces/PaginatedJustificationCountList.md deleted file mode 100644 index eecce3a55..000000000 --- a/packages/insights/doc/interfaces/PaginatedJustificationCountList.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / PaginatedJustificationCountList - -# Interface: PaginatedJustificationCountList - -**`Export`** - -PaginatedJustificationCountList - -## Table of contents - -### Properties - -- [data](PaginatedJustificationCountList.md#data) -- [links](PaginatedJustificationCountList.md#links) -- [meta](PaginatedJustificationCountList.md#meta) - -## Properties - -### data - -• `Optional` **data**: [`JustificationCount`](JustificationCount.md)[] - -**`Memberof`** - -PaginatedJustificationCountList - -#### Defined in - -[api.ts:673](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L673) - -___ - -### links - -• `Optional` **links**: [`PaginatedAckListLinks`](PaginatedAckListLinks.md) - -**`Memberof`** - -PaginatedJustificationCountList - -#### Defined in - -[api.ts:667](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L667) - -___ - -### meta - -• `Optional` **meta**: [`PaginatedAckListMeta`](PaginatedAckListMeta.md) - -**`Memberof`** - -PaginatedJustificationCountList - -#### Defined in - -[api.ts:661](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L661) diff --git a/packages/insights/doc/interfaces/PaginatedOrgIdList.md b/packages/insights/doc/interfaces/PaginatedOrgIdList.md deleted file mode 100644 index e0d5bc383..000000000 --- a/packages/insights/doc/interfaces/PaginatedOrgIdList.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / PaginatedOrgIdList - -# Interface: PaginatedOrgIdList - -**`Export`** - -PaginatedOrgIdList - -## Table of contents - -### Properties - -- [data](PaginatedOrgIdList.md#data) -- [links](PaginatedOrgIdList.md#links) -- [meta](PaginatedOrgIdList.md#meta) - -## Properties - -### data - -• `Optional` **data**: [`OrgId`](OrgId.md)[] - -**`Memberof`** - -PaginatedOrgIdList - -#### Defined in - -[api.ts:698](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L698) - -___ - -### links - -• `Optional` **links**: [`PaginatedAckListLinks`](PaginatedAckListLinks.md) - -**`Memberof`** - -PaginatedOrgIdList - -#### Defined in - -[api.ts:692](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L692) - -___ - -### meta - -• `Optional` **meta**: [`PaginatedAckListMeta`](PaginatedAckListMeta.md) - -**`Memberof`** - -PaginatedOrgIdList - -#### Defined in - -[api.ts:686](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L686) diff --git a/packages/insights/doc/interfaces/PaginatedPathwayList.md b/packages/insights/doc/interfaces/PaginatedPathwayList.md deleted file mode 100644 index 28a64dc5c..000000000 --- a/packages/insights/doc/interfaces/PaginatedPathwayList.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / PaginatedPathwayList - -# Interface: PaginatedPathwayList - -**`Export`** - -PaginatedPathwayList - -## Table of contents - -### Properties - -- [data](PaginatedPathwayList.md#data) -- [links](PaginatedPathwayList.md#links) -- [meta](PaginatedPathwayList.md#meta) - -## Properties - -### data - -• `Optional` **data**: [`Pathway`](Pathway.md)[] - -**`Memberof`** - -PaginatedPathwayList - -#### Defined in - -[api.ts:723](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L723) - -___ - -### links - -• `Optional` **links**: [`PaginatedAckListLinks`](PaginatedAckListLinks.md) - -**`Memberof`** - -PaginatedPathwayList - -#### Defined in - -[api.ts:717](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L717) - -___ - -### meta - -• `Optional` **meta**: [`PaginatedAckListMeta`](PaginatedAckListMeta.md) - -**`Memberof`** - -PaginatedPathwayList - -#### Defined in - -[api.ts:711](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L711) diff --git a/packages/insights/doc/interfaces/PaginatedRuleForAccountList.md b/packages/insights/doc/interfaces/PaginatedRuleForAccountList.md deleted file mode 100644 index 7c3775080..000000000 --- a/packages/insights/doc/interfaces/PaginatedRuleForAccountList.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / PaginatedRuleForAccountList - -# Interface: PaginatedRuleForAccountList - -**`Export`** - -PaginatedRuleForAccountList - -## Table of contents - -### Properties - -- [data](PaginatedRuleForAccountList.md#data) -- [links](PaginatedRuleForAccountList.md#links) -- [meta](PaginatedRuleForAccountList.md#meta) - -## Properties - -### data - -• `Optional` **data**: [`RuleForAccount`](RuleForAccount.md)[] - -**`Memberof`** - -PaginatedRuleForAccountList - -#### Defined in - -[api.ts:748](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L748) - -___ - -### links - -• `Optional` **links**: [`PaginatedAckListLinks`](PaginatedAckListLinks.md) - -**`Memberof`** - -PaginatedRuleForAccountList - -#### Defined in - -[api.ts:742](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L742) - -___ - -### meta - -• `Optional` **meta**: [`PaginatedAckListMeta`](PaginatedAckListMeta.md) - -**`Memberof`** - -PaginatedRuleForAccountList - -#### Defined in - -[api.ts:736](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L736) diff --git a/packages/insights/doc/interfaces/PaginatedRuleRatingList.md b/packages/insights/doc/interfaces/PaginatedRuleRatingList.md deleted file mode 100644 index b48cbb2b0..000000000 --- a/packages/insights/doc/interfaces/PaginatedRuleRatingList.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / PaginatedRuleRatingList - -# Interface: PaginatedRuleRatingList - -**`Export`** - -PaginatedRuleRatingList - -## Table of contents - -### Properties - -- [data](PaginatedRuleRatingList.md#data) -- [links](PaginatedRuleRatingList.md#links) -- [meta](PaginatedRuleRatingList.md#meta) - -## Properties - -### data - -• `Optional` **data**: [`RuleRating`](RuleRating.md)[] - -**`Memberof`** - -PaginatedRuleRatingList - -#### Defined in - -[api.ts:773](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L773) - -___ - -### links - -• `Optional` **links**: [`PaginatedAckListLinks`](PaginatedAckListLinks.md) - -**`Memberof`** - -PaginatedRuleRatingList - -#### Defined in - -[api.ts:767](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L767) - -___ - -### meta - -• `Optional` **meta**: [`PaginatedAckListMeta`](PaginatedAckListMeta.md) - -**`Memberof`** - -PaginatedRuleRatingList - -#### Defined in - -[api.ts:761](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L761) diff --git a/packages/insights/doc/interfaces/PaginatedRuleRatingStatsList.md b/packages/insights/doc/interfaces/PaginatedRuleRatingStatsList.md deleted file mode 100644 index d6c9d73f0..000000000 --- a/packages/insights/doc/interfaces/PaginatedRuleRatingStatsList.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / PaginatedRuleRatingStatsList - -# Interface: PaginatedRuleRatingStatsList - -**`Export`** - -PaginatedRuleRatingStatsList - -## Table of contents - -### Properties - -- [data](PaginatedRuleRatingStatsList.md#data) -- [links](PaginatedRuleRatingStatsList.md#links) -- [meta](PaginatedRuleRatingStatsList.md#meta) - -## Properties - -### data - -• `Optional` **data**: [`RuleRatingStats`](RuleRatingStats.md)[] - -**`Memberof`** - -PaginatedRuleRatingStatsList - -#### Defined in - -[api.ts:798](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L798) - -___ - -### links - -• `Optional` **links**: [`PaginatedAckListLinks`](PaginatedAckListLinks.md) - -**`Memberof`** - -PaginatedRuleRatingStatsList - -#### Defined in - -[api.ts:792](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L792) - -___ - -### meta - -• `Optional` **meta**: [`PaginatedAckListMeta`](PaginatedAckListMeta.md) - -**`Memberof`** - -PaginatedRuleRatingStatsList - -#### Defined in - -[api.ts:786](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L786) diff --git a/packages/insights/doc/interfaces/PaginatedSubscriptionExcludedAccountList.md b/packages/insights/doc/interfaces/PaginatedSubscriptionExcludedAccountList.md deleted file mode 100644 index 579c33d92..000000000 --- a/packages/insights/doc/interfaces/PaginatedSubscriptionExcludedAccountList.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / PaginatedSubscriptionExcludedAccountList - -# Interface: PaginatedSubscriptionExcludedAccountList - -**`Export`** - -PaginatedSubscriptionExcludedAccountList - -## Table of contents - -### Properties - -- [data](PaginatedSubscriptionExcludedAccountList.md#data) -- [links](PaginatedSubscriptionExcludedAccountList.md#links) -- [meta](PaginatedSubscriptionExcludedAccountList.md#meta) - -## Properties - -### data - -• `Optional` **data**: [`SubscriptionExcludedAccount`](SubscriptionExcludedAccount.md)[] - -**`Memberof`** - -PaginatedSubscriptionExcludedAccountList - -#### Defined in - -[api.ts:823](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L823) - -___ - -### links - -• `Optional` **links**: [`PaginatedAckListLinks`](PaginatedAckListLinks.md) - -**`Memberof`** - -PaginatedSubscriptionExcludedAccountList - -#### Defined in - -[api.ts:817](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L817) - -___ - -### meta - -• `Optional` **meta**: [`PaginatedAckListMeta`](PaginatedAckListMeta.md) - -**`Memberof`** - -PaginatedSubscriptionExcludedAccountList - -#### Defined in - -[api.ts:811](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L811) diff --git a/packages/insights/doc/interfaces/PaginatedSystemList.md b/packages/insights/doc/interfaces/PaginatedSystemList.md deleted file mode 100644 index 2530ff731..000000000 --- a/packages/insights/doc/interfaces/PaginatedSystemList.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / PaginatedSystemList - -# Interface: PaginatedSystemList - -**`Export`** - -PaginatedSystemList - -## Table of contents - -### Properties - -- [data](PaginatedSystemList.md#data) -- [links](PaginatedSystemList.md#links) -- [meta](PaginatedSystemList.md#meta) - -## Properties - -### data - -• `Optional` **data**: [`System`](System.md)[] - -**`Memberof`** - -PaginatedSystemList - -#### Defined in - -[api.ts:848](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L848) - -___ - -### links - -• `Optional` **links**: [`PaginatedAckListLinks`](PaginatedAckListLinks.md) - -**`Memberof`** - -PaginatedSystemList - -#### Defined in - -[api.ts:842](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L842) - -___ - -### meta - -• `Optional` **meta**: [`PaginatedAckListMeta`](PaginatedAckListMeta.md) - -**`Memberof`** - -PaginatedSystemList - -#### Defined in - -[api.ts:836](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L836) diff --git a/packages/insights/doc/interfaces/PaginatedSystemsDetailList.md b/packages/insights/doc/interfaces/PaginatedSystemsDetailList.md deleted file mode 100644 index 5f6cfc8d2..000000000 --- a/packages/insights/doc/interfaces/PaginatedSystemsDetailList.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / PaginatedSystemsDetailList - -# Interface: PaginatedSystemsDetailList - -**`Export`** - -PaginatedSystemsDetailList - -## Table of contents - -### Properties - -- [data](PaginatedSystemsDetailList.md#data) -- [links](PaginatedSystemsDetailList.md#links) -- [meta](PaginatedSystemsDetailList.md#meta) - -## Properties - -### data - -• `Optional` **data**: [`SystemsDetail`](SystemsDetail.md)[] - -**`Memberof`** - -PaginatedSystemsDetailList - -#### Defined in - -[api.ts:873](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L873) - -___ - -### links - -• `Optional` **links**: [`PaginatedAckListLinks`](PaginatedAckListLinks.md) - -**`Memberof`** - -PaginatedSystemsDetailList - -#### Defined in - -[api.ts:867](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L867) - -___ - -### meta - -• `Optional` **meta**: [`PaginatedAckListMeta`](PaginatedAckListMeta.md) - -**`Memberof`** - -PaginatedSystemsDetailList - -#### Defined in - -[api.ts:861](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L861) diff --git a/packages/insights/doc/interfaces/PatchedTopicEdit.md b/packages/insights/doc/interfaces/PatchedTopicEdit.md deleted file mode 100644 index fa5af55e8..000000000 --- a/packages/insights/doc/interfaces/PatchedTopicEdit.md +++ /dev/null @@ -1,106 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / PatchedTopicEdit - -# Interface: PatchedTopicEdit - -Create or edit topics. - -**`Export`** - -PatchedTopicEdit - -## Table of contents - -### Properties - -- [description](PatchedTopicEdit.md#description) -- [enabled](PatchedTopicEdit.md#enabled) -- [featured](PatchedTopicEdit.md#featured) -- [name](PatchedTopicEdit.md#name) -- [slug](PatchedTopicEdit.md#slug) -- [tag](PatchedTopicEdit.md#tag) - -## Properties - -### description - -• `Optional` **description**: `string` - -**`Memberof`** - -PatchedTopicEdit - -#### Defined in - -[api.ts:898](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L898) - -___ - -### enabled - -• `Optional` **enabled**: `boolean` - -**`Memberof`** - -PatchedTopicEdit - -#### Defined in - -[api.ts:916](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L916) - -___ - -### featured - -• `Optional` **featured**: `boolean` - -**`Memberof`** - -PatchedTopicEdit - -#### Defined in - -[api.ts:910](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L910) - -___ - -### name - -• `Optional` **name**: `string` - -**`Memberof`** - -PatchedTopicEdit - -#### Defined in - -[api.ts:886](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L886) - -___ - -### slug - -• `Optional` **slug**: `string` - -Rule topic slug - -**`Memberof`** - -PatchedTopicEdit - -#### Defined in - -[api.ts:892](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L892) - -___ - -### tag - -• `Optional` **tag**: `string` - -**`Memberof`** - -PatchedTopicEdit - -#### Defined in - -[api.ts:904](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L904) diff --git a/packages/insights/doc/interfaces/Pathway.md b/packages/insights/doc/interfaces/Pathway.md deleted file mode 100644 index c26301b20..000000000 --- a/packages/insights/doc/interfaces/Pathway.md +++ /dev/null @@ -1,269 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / Pathway - -# Interface: Pathway - -Serializer specifically for listing all Pathways currently in the system - -**`Export`** - -Pathway - -## Table of contents - -### Properties - -- [categories](Pathway.md#categories) -- [component](Pathway.md#component) -- [critical\_risk\_count](Pathway.md#critical_risk_count) -- [description](Pathway.md#description) -- [has\_incident](Pathway.md#has_incident) -- [has\_playbook](Pathway.md#has_playbook) -- [high\_risk\_count](Pathway.md#high_risk_count) -- [impacted\_systems\_count](Pathway.md#impacted_systems_count) -- [incident\_count](Pathway.md#incident_count) -- [low\_risk\_count](Pathway.md#low_risk_count) -- [medium\_risk\_count](Pathway.md#medium_risk_count) -- [name](Pathway.md#name) -- [publish\_date](Pathway.md#publish_date) -- [reboot\_required](Pathway.md#reboot_required) -- [recommendation\_level](Pathway.md#recommendation_level) -- [resolution\_risk](Pathway.md#resolution_risk) -- [slug](Pathway.md#slug) - -## Properties - -### categories - -• **categories**: [`RuleCategory`](RuleCategory.md)[] - -**`Memberof`** - -Pathway - -#### Defined in - -[api.ts:989](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L989) - -___ - -### component - -• **component**: `string` - -**`Memberof`** - -Pathway - -#### Defined in - -[api.ts:947](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L947) - -___ - -### critical\_risk\_count - -• **critical\_risk\_count**: `number` - -**`Memberof`** - -Pathway - -#### Defined in - -[api.ts:1007](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1007) - -___ - -### description - -• **description**: `string` - -**`Memberof`** - -Pathway - -#### Defined in - -[api.ts:941](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L941) - -___ - -### has\_incident - -• **has\_incident**: `boolean` - -**`Memberof`** - -Pathway - -#### Defined in - -[api.ts:983](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L983) - -___ - -### has\_playbook - -• **has\_playbook**: `boolean` - -**`Memberof`** - -Pathway - -#### Defined in - -[api.ts:965](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L965) - -___ - -### high\_risk\_count - -• **high\_risk\_count**: `number` - -**`Memberof`** - -Pathway - -#### Defined in - -[api.ts:1013](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1013) - -___ - -### impacted\_systems\_count - -• **impacted\_systems\_count**: `number` - -**`Memberof`** - -Pathway - -#### Defined in - -[api.ts:971](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L971) - -___ - -### incident\_count - -• **incident\_count**: `number` - -**`Memberof`** - -Pathway - -#### Defined in - -[api.ts:1001](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1001) - -___ - -### low\_risk\_count - -• **low\_risk\_count**: `number` - -**`Memberof`** - -Pathway - -#### Defined in - -[api.ts:1025](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1025) - -___ - -### medium\_risk\_count - -• **medium\_risk\_count**: `number` - -**`Memberof`** - -Pathway - -#### Defined in - -[api.ts:1019](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1019) - -___ - -### name - -• **name**: `string` - -**`Memberof`** - -Pathway - -#### Defined in - -[api.ts:935](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L935) - -___ - -### publish\_date - -• **publish\_date**: `string` - -**`Memberof`** - -Pathway - -#### Defined in - -[api.ts:959](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L959) - -___ - -### reboot\_required - -• **reboot\_required**: `boolean` - -**`Memberof`** - -Pathway - -#### Defined in - -[api.ts:977](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L977) - -___ - -### recommendation\_level - -• **recommendation\_level**: `number` - -**`Memberof`** - -Pathway - -#### Defined in - -[api.ts:995](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L995) - -___ - -### resolution\_risk - -• **resolution\_risk**: [`ResolutionRisk`](ResolutionRisk.md) - -**`Memberof`** - -Pathway - -#### Defined in - -[api.ts:953](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L953) - -___ - -### slug - -• **slug**: `string` - -**`Memberof`** - -Pathway - -#### Defined in - -[api.ts:929](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L929) diff --git a/packages/insights/doc/interfaces/PathwayInput.md b/packages/insights/doc/interfaces/PathwayInput.md deleted file mode 100644 index f7fa404a5..000000000 --- a/packages/insights/doc/interfaces/PathwayInput.md +++ /dev/null @@ -1,89 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / PathwayInput - -# Interface: PathwayInput - -Serializer specifically for handling CREATE and UPDATE views for Pathways - -**`Export`** - -PathwayInput - -## Table of contents - -### Properties - -- [component](PathwayInput.md#component) -- [description](PathwayInput.md#description) -- [name](PathwayInput.md#name) -- [publish\_date](PathwayInput.md#publish_date) -- [resolution\_risk](PathwayInput.md#resolution_risk) - -## Properties - -### component - -• **component**: `string` - -**`Memberof`** - -PathwayInput - -#### Defined in - -[api.ts:1050](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1050) - -___ - -### description - -• **description**: `string` - -**`Memberof`** - -PathwayInput - -#### Defined in - -[api.ts:1044](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1044) - -___ - -### name - -• **name**: `string` - -**`Memberof`** - -PathwayInput - -#### Defined in - -[api.ts:1038](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1038) - -___ - -### publish\_date - -• **publish\_date**: `string` - -**`Memberof`** - -PathwayInput - -#### Defined in - -[api.ts:1062](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1062) - -___ - -### resolution\_risk - -• **resolution\_risk**: `string` - -**`Memberof`** - -PathwayInput - -#### Defined in - -[api.ts:1056](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1056) diff --git a/packages/insights/doc/interfaces/PreferencesInput.md b/packages/insights/doc/interfaces/PreferencesInput.md deleted file mode 100644 index c45279631..000000000 --- a/packages/insights/doc/interfaces/PreferencesInput.md +++ /dev/null @@ -1,29 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / PreferencesInput - -# Interface: PreferencesInput - -User preferences - separated from account settings. - -**`Export`** - -PreferencesInput - -## Table of contents - -### Properties - -- [is\_subscribed](PreferencesInput.md#is_subscribed) - -## Properties - -### is\_subscribed - -• **is\_subscribed**: `boolean` - -**`Memberof`** - -PreferencesInput - -#### Defined in - -[api.ts:1075](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1075) diff --git a/packages/insights/doc/interfaces/RenderedReport.md b/packages/insights/doc/interfaces/RenderedReport.md deleted file mode 100644 index ad7bb36c9..000000000 --- a/packages/insights/doc/interfaces/RenderedReport.md +++ /dev/null @@ -1,104 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / RenderedReport - -# Interface: RenderedReport - -The actual rule fields with the report data for a particular system rendered into them, in a flat structure that\'s easier to use. - -**`Export`** - -RenderedReport - -## Table of contents - -### Properties - -- [description](RenderedReport.md#description) -- [generic](RenderedReport.md#generic) -- [more\_info](RenderedReport.md#more_info) -- [reason](RenderedReport.md#reason) -- [resolution](RenderedReport.md#resolution) -- [summary](RenderedReport.md#summary) - -## Properties - -### description - -• **description**: `string` - -**`Memberof`** - -RenderedReport - -#### Defined in - -[api.ts:1088](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1088) - -___ - -### generic - -• **generic**: `string` - -**`Memberof`** - -RenderedReport - -#### Defined in - -[api.ts:1100](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1100) - -___ - -### more\_info - -• `Optional` **more\_info**: `string` - -**`Memberof`** - -RenderedReport - -#### Defined in - -[api.ts:1112](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1112) - -___ - -### reason - -• **reason**: `string` - -**`Memberof`** - -RenderedReport - -#### Defined in - -[api.ts:1106](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1106) - -___ - -### resolution - -• **resolution**: `string` - -**`Memberof`** - -RenderedReport - -#### Defined in - -[api.ts:1118](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1118) - -___ - -### summary - -• **summary**: `string` - -**`Memberof`** - -RenderedReport - -#### Defined in - -[api.ts:1094](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1094) diff --git a/packages/insights/doc/interfaces/Report.md b/packages/insights/doc/interfaces/Report.md deleted file mode 100644 index 74b0822a4..000000000 --- a/packages/insights/doc/interfaces/Report.md +++ /dev/null @@ -1,72 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / Report - -# Interface: Report - -**`Export`** - -Report - -## Table of contents - -### Properties - -- [details](Report.md#details) -- [impacted\_date](Report.md#impacted_date) -- [resolution](Report.md#resolution) -- [rule](Report.md#rule) - -## Properties - -### details - -• **details**: `any` - -**`Memberof`** - -Report - -#### Defined in - -[api.ts:1137](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1137) - -___ - -### impacted\_date - -• **impacted\_date**: `string` - -**`Memberof`** - -Report - -#### Defined in - -[api.ts:1149](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1149) - -___ - -### resolution - -• **resolution**: [`Resolution`](Resolution.md) - -**`Memberof`** - -Report - -#### Defined in - -[api.ts:1143](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1143) - -___ - -### rule - -• **rule**: [`Rule`](Rule.md) - -**`Memberof`** - -Report - -#### Defined in - -[api.ts:1131](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1131) diff --git a/packages/insights/doc/interfaces/ReportExport.md b/packages/insights/doc/interfaces/ReportExport.md deleted file mode 100644 index f3cb3eeba..000000000 --- a/packages/insights/doc/interfaces/ReportExport.md +++ /dev/null @@ -1,104 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / ReportExport - -# Interface: ReportExport - -Report information for export. Based on CurrentReport with fields from Rule and Host pulled through for convenience. - -**`Export`** - -ReportExport - -## Table of contents - -### Properties - -- [details](ReportExport.md#details) -- [host\_id](ReportExport.md#host_id) -- [impacted\_date](ReportExport.md#impacted_date) -- [report\_time](ReportExport.md#report_time) -- [reports\_url](ReportExport.md#reports_url) -- [rule\_id](ReportExport.md#rule_id) - -## Properties - -### details - -• **details**: `any` - -**`Memberof`** - -ReportExport - -#### Defined in - -[api.ts:1186](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1186) - -___ - -### host\_id - -• **host\_id**: `string` - -**`Memberof`** - -ReportExport - -#### Defined in - -[api.ts:1168](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1168) - -___ - -### impacted\_date - -• **impacted\_date**: ``null`` \| `string` - -**`Memberof`** - -ReportExport - -#### Defined in - -[api.ts:1192](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1192) - -___ - -### report\_time - -• **report\_time**: `string` - -**`Memberof`** - -ReportExport - -#### Defined in - -[api.ts:1180](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1180) - -___ - -### reports\_url - -• **reports\_url**: `string` - -**`Memberof`** - -ReportExport - -#### Defined in - -[api.ts:1174](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1174) - -___ - -### rule\_id - -• **rule\_id**: `string` - -**`Memberof`** - -ReportExport - -#### Defined in - -[api.ts:1162](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1162) diff --git a/packages/insights/doc/interfaces/Resolution.md b/packages/insights/doc/interfaces/Resolution.md deleted file mode 100644 index 5ecf97f7e..000000000 --- a/packages/insights/doc/interfaces/Resolution.md +++ /dev/null @@ -1,72 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / Resolution - -# Interface: Resolution - -**`Export`** - -Resolution - -## Table of contents - -### Properties - -- [has\_playbook](Resolution.md#has_playbook) -- [resolution](Resolution.md#resolution) -- [resolution\_risk](Resolution.md#resolution_risk) -- [system\_type](Resolution.md#system_type) - -## Properties - -### has\_playbook - -• **has\_playbook**: `boolean` - -**`Memberof`** - -Resolution - -#### Defined in - -[api.ts:1223](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1223) - -___ - -### resolution - -• **resolution**: `string` - -**`Memberof`** - -Resolution - -#### Defined in - -[api.ts:1211](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1211) - -___ - -### resolution\_risk - -• **resolution\_risk**: [`ResolutionRisk`](ResolutionRisk.md) - -**`Memberof`** - -Resolution - -#### Defined in - -[api.ts:1217](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1217) - -___ - -### system\_type - -• **system\_type**: `number` - -**`Memberof`** - -Resolution - -#### Defined in - -[api.ts:1205](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1205) diff --git a/packages/insights/doc/interfaces/ResolutionRisk.md b/packages/insights/doc/interfaces/ResolutionRisk.md deleted file mode 100644 index b3fa34ac9..000000000 --- a/packages/insights/doc/interfaces/ResolutionRisk.md +++ /dev/null @@ -1,42 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / ResolutionRisk - -# Interface: ResolutionRisk - -**`Export`** - -ResolutionRisk - -## Table of contents - -### Properties - -- [name](ResolutionRisk.md#name) -- [risk](ResolutionRisk.md#risk) - -## Properties - -### name - -• `Optional` **name**: `string` - -**`Memberof`** - -ResolutionRisk - -#### Defined in - -[api.ts:1236](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1236) - -___ - -### risk - -• `Optional` **risk**: `number` - -**`Memberof`** - -ResolutionRisk - -#### Defined in - -[api.ts:1242](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1242) diff --git a/packages/insights/doc/interfaces/Rule.md b/packages/insights/doc/interfaces/Rule.md deleted file mode 100644 index a7d7a0b03..000000000 --- a/packages/insights/doc/interfaces/Rule.md +++ /dev/null @@ -1,303 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / Rule - -# Interface: Rule - -The standard rule information. Used for models and relations that don\'t know the account and therefore can\'t know the acks or impacted systems. - -**`Export`** - -Rule - -## Table of contents - -### Properties - -- [active](Rule.md#active) -- [category](Rule.md#category) -- [created\_at](Rule.md#created_at) -- [deleted\_at](Rule.md#deleted_at) -- [description](Rule.md#description) -- [generic](Rule.md#generic) -- [impact](Rule.md#impact) -- [likelihood](Rule.md#likelihood) -- [more\_info](Rule.md#more_info) -- [node\_id](Rule.md#node_id) -- [publish\_date](Rule.md#publish_date) -- [reason](Rule.md#reason) -- [reboot\_required](Rule.md#reboot_required) -- [resolution\_set](Rule.md#resolution_set) -- [rule\_id](Rule.md#rule_id) -- [summary](Rule.md#summary) -- [tags](Rule.md#tags) -- [total\_risk](Rule.md#total_risk) -- [updated\_at](Rule.md#updated_at) - -## Properties - -### active - -• `Optional` **active**: `boolean` - -**`Memberof`** - -Rule - -#### Defined in - -[api.ts:1285](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1285) - -___ - -### category - -• **category**: [`RuleCategory`](RuleCategory.md) - -**`Memberof`** - -Rule - -#### Defined in - -[api.ts:1291](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1291) - -___ - -### created\_at - -• **created\_at**: `string` - -**`Memberof`** - -Rule - -#### Defined in - -[api.ts:1261](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1261) - -___ - -### deleted\_at - -• `Optional` **deleted\_at**: `string` - -**`Memberof`** - -Rule - -#### Defined in - -[api.ts:1273](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1273) - -___ - -### description - -• **description**: `string` - -**`Memberof`** - -Rule - -#### Defined in - -[api.ts:1279](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1279) - -___ - -### generic - -• **generic**: `string` - -**`Memberof`** - -Rule - -#### Defined in - -[api.ts:1339](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1339) - -___ - -### impact - -• **impact**: [`RuleImpact`](RuleImpact.md) - -**`Memberof`** - -Rule - -#### Defined in - -[api.ts:1297](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1297) - -___ - -### likelihood - -• `Optional` **likelihood**: `number` - -**`Memberof`** - -Rule - -#### Defined in - -[api.ts:1303](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1303) - -___ - -### more\_info - -• `Optional` **more\_info**: `string` - -**`Memberof`** - -Rule - -#### Defined in - -[api.ts:1351](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1351) - -___ - -### node\_id - -• `Optional` **node\_id**: `string` - -KCS solution number - -**`Memberof`** - -Rule - -#### Defined in - -[api.ts:1309](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1309) - -___ - -### publish\_date - -• `Optional` **publish\_date**: ``null`` \| `string` - -**`Memberof`** - -Rule - -#### Defined in - -[api.ts:1327](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1327) - -___ - -### reason - -• **reason**: `string` - -**`Memberof`** - -Rule - -#### Defined in - -[api.ts:1345](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1345) - -___ - -### reboot\_required - -• `Optional` **reboot\_required**: `boolean` - -**`Memberof`** - -Rule - -#### Defined in - -[api.ts:1321](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1321) - -___ - -### resolution\_set - -• **resolution\_set**: [`Resolution`](Resolution.md)[] - -**`Memberof`** - -Rule - -#### Defined in - -[api.ts:1357](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1357) - -___ - -### rule\_id - -• **rule\_id**: `string` - -Rule ID from Insights - -**`Memberof`** - -Rule - -#### Defined in - -[api.ts:1255](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1255) - -___ - -### summary - -• **summary**: `string` - -**`Memberof`** - -Rule - -#### Defined in - -[api.ts:1333](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1333) - -___ - -### tags - -• **tags**: `string` - -**`Memberof`** - -Rule - -#### Defined in - -[api.ts:1315](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1315) - -___ - -### total\_risk - -• `Optional` **total\_risk**: `number` - -**`Memberof`** - -Rule - -#### Defined in - -[api.ts:1363](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1363) - -___ - -### updated\_at - -• **updated\_at**: `string` - -**`Memberof`** - -Rule - -#### Defined in - -[api.ts:1267](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1267) diff --git a/packages/insights/doc/interfaces/RuleCategory.md b/packages/insights/doc/interfaces/RuleCategory.md deleted file mode 100644 index 1351286bc..000000000 --- a/packages/insights/doc/interfaces/RuleCategory.md +++ /dev/null @@ -1,42 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / RuleCategory - -# Interface: RuleCategory - -**`Export`** - -RuleCategory - -## Table of contents - -### Properties - -- [id](RuleCategory.md#id) -- [name](RuleCategory.md#name) - -## Properties - -### id - -• **id**: `number` - -**`Memberof`** - -RuleCategory - -#### Defined in - -[api.ts:1376](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1376) - -___ - -### name - -• **name**: `string` - -**`Memberof`** - -RuleCategory - -#### Defined in - -[api.ts:1382](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1382) diff --git a/packages/insights/doc/interfaces/RuleExport.md b/packages/insights/doc/interfaces/RuleExport.md deleted file mode 100644 index 51de29c5e..000000000 --- a/packages/insights/doc/interfaces/RuleExport.md +++ /dev/null @@ -1,393 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / RuleExport - -# Interface: RuleExport - -Rule information for export. - -**`Export`** - -RuleExport - -## Table of contents - -### Properties - -- [active](RuleExport.md#active) -- [category](RuleExport.md#category) -- [created\_at](RuleExport.md#created_at) -- [deleted\_at](RuleExport.md#deleted_at) -- [description](RuleExport.md#description) -- [generic](RuleExport.md#generic) -- [hosts\_acked\_count](RuleExport.md#hosts_acked_count) -- [impact](RuleExport.md#impact) -- [impacted\_systems\_count](RuleExport.md#impacted_systems_count) -- [likelihood](RuleExport.md#likelihood) -- [more\_info](RuleExport.md#more_info) -- [node\_id](RuleExport.md#node_id) -- [playbook\_count](RuleExport.md#playbook_count) -- [publish\_date](RuleExport.md#publish_date) -- [rating](RuleExport.md#rating) -- [reason](RuleExport.md#reason) -- [reboot\_required](RuleExport.md#reboot_required) -- [reports\_shown](RuleExport.md#reports_shown) -- [resolution\_set](RuleExport.md#resolution_set) -- [rule\_id](RuleExport.md#rule_id) -- [rule\_status](RuleExport.md#rule_status) -- [summary](RuleExport.md#summary) -- [tags](RuleExport.md#tags) -- [total\_risk](RuleExport.md#total_risk) -- [updated\_at](RuleExport.md#updated_at) - -## Properties - -### active - -• `Optional` **active**: `boolean` - -**`Memberof`** - -RuleExport - -#### Defined in - -[api.ts:1425](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1425) - -___ - -### category - -• **category**: `string` - -**`Memberof`** - -RuleExport - -#### Defined in - -[api.ts:1431](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1431) - -___ - -### created\_at - -• **created\_at**: `string` - -**`Memberof`** - -RuleExport - -#### Defined in - -[api.ts:1401](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1401) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `string` - -**`Memberof`** - -RuleExport - -#### Defined in - -[api.ts:1413](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1413) - -___ - -### description - -• **description**: `string` - -**`Memberof`** - -RuleExport - -#### Defined in - -[api.ts:1419](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1419) - -___ - -### generic - -• **generic**: `string` - -**`Memberof`** - -RuleExport - -#### Defined in - -[api.ts:1485](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1485) - -___ - -### hosts\_acked\_count - -• **hosts\_acked\_count**: `number` - -**`Memberof`** - -RuleExport - -#### Defined in - -[api.ts:1527](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1527) - -___ - -### impact - -• **impact**: `string` - -**`Memberof`** - -RuleExport - -#### Defined in - -[api.ts:1437](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1437) - -___ - -### impacted\_systems\_count - -• **impacted\_systems\_count**: `number` - -**`Memberof`** - -RuleExport - -#### Defined in - -[api.ts:1503](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1503) - -___ - -### likelihood - -• `Optional` **likelihood**: `number` - -**`Memberof`** - -RuleExport - -#### Defined in - -[api.ts:1443](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1443) - -___ - -### more\_info - -• `Optional` **more\_info**: `string` - -**`Memberof`** - -RuleExport - -#### Defined in - -[api.ts:1497](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1497) - -___ - -### node\_id - -• `Optional` **node\_id**: `string` - -KCS solution number - -**`Memberof`** - -RuleExport - -#### Defined in - -[api.ts:1449](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1449) - -___ - -### playbook\_count - -• **playbook\_count**: `number` - -**`Memberof`** - -RuleExport - -#### Defined in - -[api.ts:1461](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1461) - -___ - -### publish\_date - -• `Optional` **publish\_date**: ``null`` \| `string` - -**`Memberof`** - -RuleExport - -#### Defined in - -[api.ts:1473](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1473) - -___ - -### rating - -• **rating**: `number` - -**`Memberof`** - -RuleExport - -#### Defined in - -[api.ts:1533](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1533) - -___ - -### reason - -• **reason**: `string` - -**`Memberof`** - -RuleExport - -#### Defined in - -[api.ts:1491](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1491) - -___ - -### reboot\_required - -• `Optional` **reboot\_required**: `boolean` - -**`Memberof`** - -RuleExport - -#### Defined in - -[api.ts:1467](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1467) - -___ - -### reports\_shown - -• **reports\_shown**: `boolean` - -**`Memberof`** - -RuleExport - -#### Defined in - -[api.ts:1539](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1539) - -___ - -### resolution\_set - -• **resolution\_set**: [`Resolution`](Resolution.md)[] - -**`Memberof`** - -RuleExport - -#### Defined in - -[api.ts:1515](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1515) - -___ - -### rule\_id - -• **rule\_id**: `string` - -Rule ID from Insights - -**`Memberof`** - -RuleExport - -#### Defined in - -[api.ts:1395](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1395) - -___ - -### rule\_status - -• **rule\_status**: `string` - -**`Memberof`** - -RuleExport - -#### Defined in - -[api.ts:1509](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1509) - -___ - -### summary - -• **summary**: `string` - -**`Memberof`** - -RuleExport - -#### Defined in - -[api.ts:1479](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1479) - -___ - -### tags - -• **tags**: `string` - -**`Memberof`** - -RuleExport - -#### Defined in - -[api.ts:1455](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1455) - -___ - -### total\_risk - -• `Optional` **total\_risk**: `number` - -**`Memberof`** - -RuleExport - -#### Defined in - -[api.ts:1521](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1521) - -___ - -### updated\_at - -• **updated\_at**: `string` - -**`Memberof`** - -RuleExport - -#### Defined in - -[api.ts:1407](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1407) diff --git a/packages/insights/doc/interfaces/RuleForAccount.md b/packages/insights/doc/interfaces/RuleForAccount.md deleted file mode 100644 index bde0ba183..000000000 --- a/packages/insights/doc/interfaces/RuleForAccount.md +++ /dev/null @@ -1,408 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / RuleForAccount - -# Interface: RuleForAccount - -Rule information when we know the account, and therefore can calculate the number of impacted systems and the reports_shown/rule_status flags. We have to declare those explicitly here because they\'re not part of the model. - -**`Export`** - -RuleForAccount - -## Table of contents - -### Properties - -- [active](RuleForAccount.md#active) -- [category](RuleForAccount.md#category) -- [created\_at](RuleForAccount.md#created_at) -- [deleted\_at](RuleForAccount.md#deleted_at) -- [description](RuleForAccount.md#description) -- [generic](RuleForAccount.md#generic) -- [hosts\_acked\_count](RuleForAccount.md#hosts_acked_count) -- [impact](RuleForAccount.md#impact) -- [impacted\_systems\_count](RuleForAccount.md#impacted_systems_count) -- [likelihood](RuleForAccount.md#likelihood) -- [more\_info](RuleForAccount.md#more_info) -- [node\_id](RuleForAccount.md#node_id) -- [pathway](RuleForAccount.md#pathway) -- [playbook\_count](RuleForAccount.md#playbook_count) -- [publish\_date](RuleForAccount.md#publish_date) -- [rating](RuleForAccount.md#rating) -- [reason](RuleForAccount.md#reason) -- [reboot\_required](RuleForAccount.md#reboot_required) -- [reports\_shown](RuleForAccount.md#reports_shown) -- [resolution\_set](RuleForAccount.md#resolution_set) -- [rule\_id](RuleForAccount.md#rule_id) -- [rule\_status](RuleForAccount.md#rule_status) -- [summary](RuleForAccount.md#summary) -- [tags](RuleForAccount.md#tags) -- [total\_risk](RuleForAccount.md#total_risk) -- [updated\_at](RuleForAccount.md#updated_at) - -## Properties - -### active - -• `Optional` **active**: `boolean` - -**`Memberof`** - -RuleForAccount - -#### Defined in - -[api.ts:1582](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1582) - -___ - -### category - -• **category**: [`RuleCategory`](RuleCategory.md) - -**`Memberof`** - -RuleForAccount - -#### Defined in - -[api.ts:1588](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1588) - -___ - -### created\_at - -• **created\_at**: `string` - -**`Memberof`** - -RuleForAccount - -#### Defined in - -[api.ts:1558](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1558) - -___ - -### deleted\_at - -• `Optional` **deleted\_at**: `string` - -**`Memberof`** - -RuleForAccount - -#### Defined in - -[api.ts:1570](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1570) - -___ - -### description - -• **description**: `string` - -**`Memberof`** - -RuleForAccount - -#### Defined in - -[api.ts:1576](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1576) - -___ - -### generic - -• **generic**: `string` - -**`Memberof`** - -RuleForAccount - -#### Defined in - -[api.ts:1642](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1642) - -___ - -### hosts\_acked\_count - -• **hosts\_acked\_count**: `number` - -**`Memberof`** - -RuleForAccount - -#### Defined in - -[api.ts:1690](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1690) - -___ - -### impact - -• **impact**: [`RuleImpact`](RuleImpact.md) - -**`Memberof`** - -RuleForAccount - -#### Defined in - -[api.ts:1594](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1594) - -___ - -### impacted\_systems\_count - -• **impacted\_systems\_count**: `number` - -**`Memberof`** - -RuleForAccount - -#### Defined in - -[api.ts:1660](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1660) - -___ - -### likelihood - -• `Optional` **likelihood**: `number` - -**`Memberof`** - -RuleForAccount - -#### Defined in - -[api.ts:1600](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1600) - -___ - -### more\_info - -• `Optional` **more\_info**: `string` - -**`Memberof`** - -RuleForAccount - -#### Defined in - -[api.ts:1654](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1654) - -___ - -### node\_id - -• `Optional` **node\_id**: `string` - -KCS solution number - -**`Memberof`** - -RuleForAccount - -#### Defined in - -[api.ts:1606](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1606) - -___ - -### pathway - -• `Optional` **pathway**: [`RulePathway`](RulePathway.md) - -**`Memberof`** - -RuleForAccount - -#### Defined in - -[api.ts:1702](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1702) - -___ - -### playbook\_count - -• **playbook\_count**: `number` - -**`Memberof`** - -RuleForAccount - -#### Defined in - -[api.ts:1618](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1618) - -___ - -### publish\_date - -• `Optional` **publish\_date**: ``null`` \| `string` - -**`Memberof`** - -RuleForAccount - -#### Defined in - -[api.ts:1630](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1630) - -___ - -### rating - -• **rating**: `number` - -**`Memberof`** - -RuleForAccount - -#### Defined in - -[api.ts:1696](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1696) - -___ - -### reason - -• **reason**: `string` - -**`Memberof`** - -RuleForAccount - -#### Defined in - -[api.ts:1648](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1648) - -___ - -### reboot\_required - -• `Optional` **reboot\_required**: `boolean` - -**`Memberof`** - -RuleForAccount - -#### Defined in - -[api.ts:1624](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1624) - -___ - -### reports\_shown - -• **reports\_shown**: `boolean` - -**`Memberof`** - -RuleForAccount - -#### Defined in - -[api.ts:1666](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1666) - -___ - -### resolution\_set - -• **resolution\_set**: [`Resolution`](Resolution.md)[] - -**`Memberof`** - -RuleForAccount - -#### Defined in - -[api.ts:1678](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1678) - -___ - -### rule\_id - -• **rule\_id**: `string` - -Rule ID from Insights - -**`Memberof`** - -RuleForAccount - -#### Defined in - -[api.ts:1552](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1552) - -___ - -### rule\_status - -• **rule\_status**: `string` - -**`Memberof`** - -RuleForAccount - -#### Defined in - -[api.ts:1672](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1672) - -___ - -### summary - -• **summary**: `string` - -**`Memberof`** - -RuleForAccount - -#### Defined in - -[api.ts:1636](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1636) - -___ - -### tags - -• **tags**: `string` - -**`Memberof`** - -RuleForAccount - -#### Defined in - -[api.ts:1612](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1612) - -___ - -### total\_risk - -• `Optional` **total\_risk**: `number` - -**`Memberof`** - -RuleForAccount - -#### Defined in - -[api.ts:1684](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1684) - -___ - -### updated\_at - -• **updated\_at**: `string` - -**`Memberof`** - -RuleForAccount - -#### Defined in - -[api.ts:1564](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1564) diff --git a/packages/insights/doc/interfaces/RuleImpact.md b/packages/insights/doc/interfaces/RuleImpact.md deleted file mode 100644 index 0099adcd7..000000000 --- a/packages/insights/doc/interfaces/RuleImpact.md +++ /dev/null @@ -1,42 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / RuleImpact - -# Interface: RuleImpact - -**`Export`** - -RuleImpact - -## Table of contents - -### Properties - -- [impact](RuleImpact.md#impact) -- [name](RuleImpact.md#name) - -## Properties - -### impact - -• `Optional` **impact**: `number` - -**`Memberof`** - -RuleImpact - -#### Defined in - -[api.ts:1721](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1721) - -___ - -### name - -• `Optional` **name**: `string` - -**`Memberof`** - -RuleImpact - -#### Defined in - -[api.ts:1715](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1715) diff --git a/packages/insights/doc/interfaces/RulePathway.md b/packages/insights/doc/interfaces/RulePathway.md deleted file mode 100644 index 0fa732d1f..000000000 --- a/packages/insights/doc/interfaces/RulePathway.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / RulePathway - -# Interface: RulePathway - -**`Export`** - -RulePathway - -## Table of contents - -### Properties - -- [component](RulePathway.md#component) -- [name](RulePathway.md#name) -- [resolution\_risk](RulePathway.md#resolution_risk) - -## Properties - -### component - -• **component**: `string` - -**`Memberof`** - -RulePathway - -#### Defined in - -[api.ts:1740](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1740) - -___ - -### name - -• **name**: `string` - -**`Memberof`** - -RulePathway - -#### Defined in - -[api.ts:1734](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1734) - -___ - -### resolution\_risk - -• **resolution\_risk**: [`ResolutionRisk`](ResolutionRisk.md) - -**`Memberof`** - -RulePathway - -#### Defined in - -[api.ts:1746](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1746) diff --git a/packages/insights/doc/interfaces/RuleRating.md b/packages/insights/doc/interfaces/RuleRating.md deleted file mode 100644 index 2125d2cd1..000000000 --- a/packages/insights/doc/interfaces/RuleRating.md +++ /dev/null @@ -1,48 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / RuleRating - -# Interface: RuleRating - -Rule ratings list the rating (-1, 0 or +1) for one or more rules. The rule is listed by its Insights Rule ID. - -**`Export`** - -RuleRating - -## Table of contents - -### Properties - -- [rating](RuleRating.md#rating) -- [rule](RuleRating.md#rule) - -## Properties - -### rating - -• **rating**: [`RuleRatingRatingEnum`](../enums/RuleRatingRatingEnum.md) - -* `-1` - Dislike * `0` - Neutral * `1` - Like - -**`Memberof`** - -RuleRating - -#### Defined in - -[api.ts:1765](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1765) - -___ - -### rule - -• **rule**: `string` - -Rule ID from Insights - -**`Memberof`** - -RuleRating - -#### Defined in - -[api.ts:1759](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1759) diff --git a/packages/insights/doc/interfaces/RuleRatingStats.md b/packages/insights/doc/interfaces/RuleRatingStats.md deleted file mode 100644 index 687496afc..000000000 --- a/packages/insights/doc/interfaces/RuleRatingStats.md +++ /dev/null @@ -1,74 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / RuleRatingStats - -# Interface: RuleRatingStats - -Output of statistics view of rule ratings - rule ID and totals of ratings. - -**`Export`** - -RuleRatingStats - -## Table of contents - -### Properties - -- [rule](RuleRatingStats.md#rule) -- [total\_negative](RuleRatingStats.md#total_negative) -- [total\_positive](RuleRatingStats.md#total_positive) -- [total\_ratings](RuleRatingStats.md#total_ratings) - -## Properties - -### rule - -• **rule**: `string` - -**`Memberof`** - -RuleRatingStats - -#### Defined in - -[api.ts:1789](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1789) - -___ - -### total\_negative - -• **total\_negative**: `number` - -**`Memberof`** - -RuleRatingStats - -#### Defined in - -[api.ts:1807](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1807) - -___ - -### total\_positive - -• **total\_positive**: `number` - -**`Memberof`** - -RuleRatingStats - -#### Defined in - -[api.ts:1801](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1801) - -___ - -### total\_ratings - -• **total\_ratings**: `number` - -**`Memberof`** - -RuleRatingStats - -#### Defined in - -[api.ts:1795](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1795) diff --git a/packages/insights/doc/interfaces/RuleSystemsExport.md b/packages/insights/doc/interfaces/RuleSystemsExport.md deleted file mode 100644 index 29e66a2af..000000000 --- a/packages/insights/doc/interfaces/RuleSystemsExport.md +++ /dev/null @@ -1,33 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / RuleSystemsExport - -# Interface: RuleSystemsExport - -List of systems with current reports for each rule. - -**`Export`** - -RuleSystemsExport - -## Table of contents - -### Properties - -- [rules](RuleSystemsExport.md#rules) - -## Properties - -### rules - -• **rules**: `Object` - -**`Memberof`** - -RuleSystemsExport - -#### Index signature - -▪ [key: `string`]: `string`[] - -#### Defined in - -[api.ts:1820](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1820) diff --git a/packages/insights/doc/interfaces/RuleUsageStats.md b/packages/insights/doc/interfaces/RuleUsageStats.md deleted file mode 100644 index 78359d4eb..000000000 --- a/packages/insights/doc/interfaces/RuleUsageStats.md +++ /dev/null @@ -1,104 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / RuleUsageStats - -# Interface: RuleUsageStats - -Rule usage statistics for rule developers. - -**`Export`** - -RuleUsageStats - -## Table of contents - -### Properties - -- [accounts\_acked](RuleUsageStats.md#accounts_acked) -- [accounts\_hit](RuleUsageStats.md#accounts_hit) -- [active](RuleUsageStats.md#active) -- [description](RuleUsageStats.md#description) -- [rule\_id](RuleUsageStats.md#rule_id) -- [systems\_hit](RuleUsageStats.md#systems_hit) - -## Properties - -### accounts\_acked - -• **accounts\_acked**: `number` - -**`Memberof`** - -RuleUsageStats - -#### Defined in - -[api.ts:1863](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1863) - -___ - -### accounts\_hit - -• **accounts\_hit**: `number` - -**`Memberof`** - -RuleUsageStats - -#### Defined in - -[api.ts:1857](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1857) - -___ - -### active - -• **active**: `boolean` - -**`Memberof`** - -RuleUsageStats - -#### Defined in - -[api.ts:1845](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1845) - -___ - -### description - -• **description**: `string` - -**`Memberof`** - -RuleUsageStats - -#### Defined in - -[api.ts:1839](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1839) - -___ - -### rule\_id - -• **rule\_id**: `string` - -**`Memberof`** - -RuleUsageStats - -#### Defined in - -[api.ts:1833](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1833) - -___ - -### systems\_hit - -• **systems\_hit**: `number` - -**`Memberof`** - -RuleUsageStats - -#### Defined in - -[api.ts:1851](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1851) diff --git a/packages/insights/doc/interfaces/SettingDDF.md b/packages/insights/doc/interfaces/SettingDDF.md deleted file mode 100644 index f8f750f90..000000000 --- a/packages/insights/doc/interfaces/SettingDDF.md +++ /dev/null @@ -1,149 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / SettingDDF - -# Interface: SettingDDF - -Outputs the description of the settings in a Data-Driven Forms format. - -**`Export`** - -SettingDDF - -## Table of contents - -### Properties - -- [component](SettingDDF.md#component) -- [description](SettingDDF.md#description) -- [helperText](SettingDDF.md#helpertext) -- [initialValue](SettingDDF.md#initialvalue) -- [isDisabled](SettingDDF.md#isdisabled) -- [isRequired](SettingDDF.md#isrequired) -- [label](SettingDDF.md#label) -- [name](SettingDDF.md#name) -- [title](SettingDDF.md#title) - -## Properties - -### component - -• **component**: `string` - -**`Memberof`** - -SettingDDF - -#### Defined in - -[api.ts:1906](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1906) - -___ - -### description - -• `Optional` **description**: `string` - -**`Memberof`** - -SettingDDF - -#### Defined in - -[api.ts:1894](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1894) - -___ - -### helperText - -• `Optional` **helperText**: `string` - -**`Memberof`** - -SettingDDF - -#### Defined in - -[api.ts:1900](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1900) - -___ - -### initialValue - -• **initialValue**: `boolean` - -**`Memberof`** - -SettingDDF - -#### Defined in - -[api.ts:1918](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1918) - -___ - -### isDisabled - -• **isDisabled**: `boolean` - -**`Memberof`** - -SettingDDF - -#### Defined in - -[api.ts:1924](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1924) - -___ - -### isRequired - -• **isRequired**: `boolean` - -**`Memberof`** - -SettingDDF - -#### Defined in - -[api.ts:1912](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1912) - -___ - -### label - -• `Optional` **label**: `string` - -**`Memberof`** - -SettingDDF - -#### Defined in - -[api.ts:1882](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1882) - -___ - -### name - -• **name**: `string` - -**`Memberof`** - -SettingDDF - -#### Defined in - -[api.ts:1876](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1876) - -___ - -### title - -• `Optional` **title**: `string` - -**`Memberof`** - -SettingDDF - -#### Defined in - -[api.ts:1888](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1888) diff --git a/packages/insights/doc/interfaces/SettingsDDF.md b/packages/insights/doc/interfaces/SettingsDDF.md deleted file mode 100644 index e20e83078..000000000 --- a/packages/insights/doc/interfaces/SettingsDDF.md +++ /dev/null @@ -1,29 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / SettingsDDF - -# Interface: SettingsDDF - -Combining the DDF fields into one \'fields\' object. - -**`Export`** - -SettingsDDF - -## Table of contents - -### Properties - -- [fields](SettingsDDF.md#fields) - -## Properties - -### fields - -• **fields**: [`SettingDDF`](SettingDDF.md)[] - -**`Memberof`** - -SettingsDDF - -#### Defined in - -[api.ts:1937](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1937) diff --git a/packages/insights/doc/interfaces/Stats.md b/packages/insights/doc/interfaces/Stats.md deleted file mode 100644 index 0fe676351..000000000 --- a/packages/insights/doc/interfaces/Stats.md +++ /dev/null @@ -1,67 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / Stats - -# Interface: Stats - -Advisor rule or report frequency statisics. - -**`Export`** - -Stats - -## Table of contents - -### Properties - -- [category](Stats.md#category) -- [total](Stats.md#total) -- [total\_risk](Stats.md#total_risk) - -## Properties - -### category - -• **category**: `Object` - -**`Memberof`** - -Stats - -#### Index signature - -▪ [key: `string`]: `number` - -#### Defined in - -[api.ts:1962](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1962) - -___ - -### total - -• **total**: `number` - -**`Memberof`** - -Stats - -#### Defined in - -[api.ts:1950](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1950) - -___ - -### total\_risk - -• **total\_risk**: `Object` - -**`Memberof`** - -Stats - -#### Index signature - -▪ [key: `string`]: `number` - -#### Defined in - -[api.ts:1956](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1956) diff --git a/packages/insights/doc/interfaces/SubscriptionExcludedAccount.md b/packages/insights/doc/interfaces/SubscriptionExcludedAccount.md deleted file mode 100644 index e03afd2f0..000000000 --- a/packages/insights/doc/interfaces/SubscriptionExcludedAccount.md +++ /dev/null @@ -1,42 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / SubscriptionExcludedAccount - -# Interface: SubscriptionExcludedAccount - -**`Export`** - -SubscriptionExcludedAccount - -## Table of contents - -### Properties - -- [account](SubscriptionExcludedAccount.md#account) -- [org\_id](SubscriptionExcludedAccount.md#org_id) - -## Properties - -### account - -• `Optional` **account**: `string` - -**`Memberof`** - -SubscriptionExcludedAccount - -#### Defined in - -[api.ts:1981](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1981) - -___ - -### org\_id - -• **org\_id**: `string` - -**`Memberof`** - -SubscriptionExcludedAccount - -#### Defined in - -[api.ts:1975](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1975) diff --git a/packages/insights/doc/interfaces/System.md b/packages/insights/doc/interfaces/System.md deleted file mode 100644 index 9c884ceb2..000000000 --- a/packages/insights/doc/interfaces/System.md +++ /dev/null @@ -1,222 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / System - -# Interface: System - -**`Export`** - -System - -## Table of contents - -### Properties - -- [all\_pathway\_hits](System.md#all_pathway_hits) -- [critical\_hits](System.md#critical_hits) -- [display\_name](System.md#display_name) -- [group\_name](System.md#group_name) -- [hits](System.md#hits) -- [important\_hits](System.md#important_hits) -- [incident\_hits](System.md#incident_hits) -- [last\_seen](System.md#last_seen) -- [low\_hits](System.md#low_hits) -- [moderate\_hits](System.md#moderate_hits) -- [pathway\_filter\_hits](System.md#pathway_filter_hits) -- [rhel\_version](System.md#rhel_version) -- [stale\_at](System.md#stale_at) -- [system\_uuid](System.md#system_uuid) - -## Properties - -### all\_pathway\_hits - -• **all\_pathway\_hits**: `number` - -**`Memberof`** - -System - -#### Defined in - -[api.ts:2054](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2054) - -___ - -### critical\_hits - -• **critical\_hits**: `number` - -**`Memberof`** - -System - -#### Defined in - -[api.ts:2024](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2024) - -___ - -### display\_name - -• **display\_name**: `string` - -**`Memberof`** - -System - -#### Defined in - -[api.ts:2000](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2000) - -___ - -### group\_name - -• **group\_name**: `string` - -**`Memberof`** - -System - -#### Defined in - -[api.ts:2072](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2072) - -___ - -### hits - -• **hits**: `number` - -**`Memberof`** - -System - -#### Defined in - -[api.ts:2018](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2018) - -___ - -### important\_hits - -• **important\_hits**: `number` - -**`Memberof`** - -System - -#### Defined in - -[api.ts:2030](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2030) - -___ - -### incident\_hits - -• **incident\_hits**: `number` - -**`Memberof`** - -System - -#### Defined in - -[api.ts:2048](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2048) - -___ - -### last\_seen - -• **last\_seen**: `string` - -**`Memberof`** - -System - -#### Defined in - -[api.ts:2006](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2006) - -___ - -### low\_hits - -• **low\_hits**: `number` - -**`Memberof`** - -System - -#### Defined in - -[api.ts:2042](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2042) - -___ - -### moderate\_hits - -• **moderate\_hits**: `number` - -**`Memberof`** - -System - -#### Defined in - -[api.ts:2036](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2036) - -___ - -### pathway\_filter\_hits - -• **pathway\_filter\_hits**: `number` - -**`Memberof`** - -System - -#### Defined in - -[api.ts:2060](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2060) - -___ - -### rhel\_version - -• **rhel\_version**: `string` - -**`Memberof`** - -System - -#### Defined in - -[api.ts:2066](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2066) - -___ - -### stale\_at - -• **stale\_at**: `string` - -**`Memberof`** - -System - -#### Defined in - -[api.ts:2012](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2012) - -___ - -### system\_uuid - -• **system\_uuid**: `string` - -**`Memberof`** - -System - -#### Defined in - -[api.ts:1994](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L1994) diff --git a/packages/insights/doc/interfaces/SystemType.md b/packages/insights/doc/interfaces/SystemType.md deleted file mode 100644 index 488e732a5..000000000 --- a/packages/insights/doc/interfaces/SystemType.md +++ /dev/null @@ -1,59 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / SystemType - -# Interface: SystemType - -RHN-based system types classified by role and product code. - -**`Export`** - -SystemType - -## Table of contents - -### Properties - -- [id](SystemType.md#id) -- [product\_code](SystemType.md#product_code) -- [role](SystemType.md#role) - -## Properties - -### id - -• **id**: `number` - -**`Memberof`** - -SystemType - -#### Defined in - -[api.ts:2085](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2085) - -___ - -### product\_code - -• **product\_code**: `string` - -**`Memberof`** - -SystemType - -#### Defined in - -[api.ts:2097](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2097) - -___ - -### role - -• **role**: `string` - -**`Memberof`** - -SystemType - -#### Defined in - -[api.ts:2091](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2091) diff --git a/packages/insights/doc/interfaces/SystemsDetail.md b/packages/insights/doc/interfaces/SystemsDetail.md deleted file mode 100644 index 76eb68094..000000000 --- a/packages/insights/doc/interfaces/SystemsDetail.md +++ /dev/null @@ -1,222 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / SystemsDetail - -# Interface: SystemsDetail - -**`Export`** - -SystemsDetail - -## Table of contents - -### Properties - -- [all\_pathway\_hits](SystemsDetail.md#all_pathway_hits) -- [critical\_hits](SystemsDetail.md#critical_hits) -- [display\_name](SystemsDetail.md#display_name) -- [hits](SystemsDetail.md#hits) -- [impacted\_date](SystemsDetail.md#impacted_date) -- [important\_hits](SystemsDetail.md#important_hits) -- [incident\_hits](SystemsDetail.md#incident_hits) -- [last\_seen](SystemsDetail.md#last_seen) -- [low\_hits](SystemsDetail.md#low_hits) -- [moderate\_hits](SystemsDetail.md#moderate_hits) -- [pathway\_filter\_hits](SystemsDetail.md#pathway_filter_hits) -- [rhel\_version](SystemsDetail.md#rhel_version) -- [stale\_at](SystemsDetail.md#stale_at) -- [system\_uuid](SystemsDetail.md#system_uuid) - -## Properties - -### all\_pathway\_hits - -• **all\_pathway\_hits**: `number` - -**`Memberof`** - -SystemsDetail - -#### Defined in - -[api.ts:2170](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2170) - -___ - -### critical\_hits - -• **critical\_hits**: `number` - -**`Memberof`** - -SystemsDetail - -#### Defined in - -[api.ts:2140](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2140) - -___ - -### display\_name - -• **display\_name**: `string` - -**`Memberof`** - -SystemsDetail - -#### Defined in - -[api.ts:2116](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2116) - -___ - -### hits - -• **hits**: `number` - -**`Memberof`** - -SystemsDetail - -#### Defined in - -[api.ts:2134](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2134) - -___ - -### impacted\_date - -• **impacted\_date**: `string` - -**`Memberof`** - -SystemsDetail - -#### Defined in - -[api.ts:2188](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2188) - -___ - -### important\_hits - -• **important\_hits**: `number` - -**`Memberof`** - -SystemsDetail - -#### Defined in - -[api.ts:2146](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2146) - -___ - -### incident\_hits - -• **incident\_hits**: `number` - -**`Memberof`** - -SystemsDetail - -#### Defined in - -[api.ts:2164](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2164) - -___ - -### last\_seen - -• **last\_seen**: `string` - -**`Memberof`** - -SystemsDetail - -#### Defined in - -[api.ts:2122](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2122) - -___ - -### low\_hits - -• **low\_hits**: `number` - -**`Memberof`** - -SystemsDetail - -#### Defined in - -[api.ts:2158](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2158) - -___ - -### moderate\_hits - -• **moderate\_hits**: `number` - -**`Memberof`** - -SystemsDetail - -#### Defined in - -[api.ts:2152](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2152) - -___ - -### pathway\_filter\_hits - -• **pathway\_filter\_hits**: `number` - -**`Memberof`** - -SystemsDetail - -#### Defined in - -[api.ts:2176](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2176) - -___ - -### rhel\_version - -• **rhel\_version**: `string` - -**`Memberof`** - -SystemsDetail - -#### Defined in - -[api.ts:2182](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2182) - -___ - -### stale\_at - -• **stale\_at**: `string` - -**`Memberof`** - -SystemsDetail - -#### Defined in - -[api.ts:2128](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2128) - -___ - -### system\_uuid - -• **system\_uuid**: `string` - -**`Memberof`** - -SystemsDetail - -#### Defined in - -[api.ts:2110](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2110) diff --git a/packages/insights/doc/interfaces/SystemsForRule.md b/packages/insights/doc/interfaces/SystemsForRule.md deleted file mode 100644 index c24a057d4..000000000 --- a/packages/insights/doc/interfaces/SystemsForRule.md +++ /dev/null @@ -1,29 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / SystemsForRule - -# Interface: SystemsForRule - -The list of Inventory Host IDs that are (currently) affected by a given rule. - -**`Export`** - -SystemsForRule - -## Table of contents - -### Properties - -- [host\_ids](SystemsForRule.md#host_ids) - -## Properties - -### host\_ids - -• **host\_ids**: `string`[] - -**`Memberof`** - -SystemsForRule - -#### Defined in - -[api.ts:2201](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2201) diff --git a/packages/insights/doc/interfaces/Topic.md b/packages/insights/doc/interfaces/Topic.md deleted file mode 100644 index 3988fdd22..000000000 --- a/packages/insights/doc/interfaces/Topic.md +++ /dev/null @@ -1,121 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / Topic - -# Interface: Topic - -Topics group rules by a tag shared by all the rules. - -**`Export`** - -Topic - -## Table of contents - -### Properties - -- [description](Topic.md#description) -- [enabled](Topic.md#enabled) -- [featured](Topic.md#featured) -- [impacted\_systems\_count](Topic.md#impacted_systems_count) -- [name](Topic.md#name) -- [slug](Topic.md#slug) -- [tag](Topic.md#tag) - -## Properties - -### description - -• **description**: `string` - -**`Memberof`** - -Topic - -#### Defined in - -[api.ts:2226](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2226) - -___ - -### enabled - -• `Optional` **enabled**: `boolean` - -**`Memberof`** - -Topic - -#### Defined in - -[api.ts:2244](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2244) - -___ - -### featured - -• `Optional` **featured**: `boolean` - -**`Memberof`** - -Topic - -#### Defined in - -[api.ts:2238](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2238) - -___ - -### impacted\_systems\_count - -• **impacted\_systems\_count**: `number` - -**`Memberof`** - -Topic - -#### Defined in - -[api.ts:2250](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2250) - -___ - -### name - -• **name**: `string` - -**`Memberof`** - -Topic - -#### Defined in - -[api.ts:2214](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2214) - -___ - -### slug - -• **slug**: `string` - -Rule topic slug - -**`Memberof`** - -Topic - -#### Defined in - -[api.ts:2220](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2220) - -___ - -### tag - -• **tag**: `string` - -**`Memberof`** - -Topic - -#### Defined in - -[api.ts:2232](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2232) diff --git a/packages/insights/doc/interfaces/TopicEdit.md b/packages/insights/doc/interfaces/TopicEdit.md deleted file mode 100644 index d222b8dab..000000000 --- a/packages/insights/doc/interfaces/TopicEdit.md +++ /dev/null @@ -1,106 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / TopicEdit - -# Interface: TopicEdit - -Create or edit topics. - -**`Export`** - -TopicEdit - -## Table of contents - -### Properties - -- [description](TopicEdit.md#description) -- [enabled](TopicEdit.md#enabled) -- [featured](TopicEdit.md#featured) -- [name](TopicEdit.md#name) -- [slug](TopicEdit.md#slug) -- [tag](TopicEdit.md#tag) - -## Properties - -### description - -• **description**: `string` - -**`Memberof`** - -TopicEdit - -#### Defined in - -[api.ts:2275](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2275) - -___ - -### enabled - -• `Optional` **enabled**: `boolean` - -**`Memberof`** - -TopicEdit - -#### Defined in - -[api.ts:2293](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2293) - -___ - -### featured - -• `Optional` **featured**: `boolean` - -**`Memberof`** - -TopicEdit - -#### Defined in - -[api.ts:2287](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2287) - -___ - -### name - -• **name**: `string` - -**`Memberof`** - -TopicEdit - -#### Defined in - -[api.ts:2263](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2263) - -___ - -### slug - -• **slug**: `string` - -Rule topic slug - -**`Memberof`** - -TopicEdit - -#### Defined in - -[api.ts:2269](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2269) - -___ - -### tag - -• **tag**: `string` - -**`Memberof`** - -TopicEdit - -#### Defined in - -[api.ts:2281](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2281) diff --git a/packages/insights/doc/interfaces/Usage.md b/packages/insights/doc/interfaces/Usage.md deleted file mode 100644 index 7b987e034..000000000 --- a/packages/insights/doc/interfaces/Usage.md +++ /dev/null @@ -1,29 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / Usage - -# Interface: Usage - -An approximation of the number of unique hits per day. - -**`Export`** - -Usage - -## Table of contents - -### Properties - -- [unique\_hits](Usage.md#unique_hits) - -## Properties - -### unique\_hits - -• **unique\_hits**: `number` - -**`Memberof`** - -Usage - -#### Defined in - -[api.ts:2306](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2306) diff --git a/packages/insights/doc/interfaces/WeeklyReportSubscription.md b/packages/insights/doc/interfaces/WeeklyReportSubscription.md deleted file mode 100644 index 0ee34dffc..000000000 --- a/packages/insights/doc/interfaces/WeeklyReportSubscription.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/insights-client](../README.md) / [Exports](../modules.md) / WeeklyReportSubscription - -# Interface: WeeklyReportSubscription - -**`Export`** - -WeeklyReportSubscription - -## Table of contents - -### Properties - -- [is\_subscribed](WeeklyReportSubscription.md#is_subscribed) - -## Properties - -### is\_subscribed - -• **is\_subscribed**: `boolean` - -**`Memberof`** - -WeeklyReportSubscription - -#### Defined in - -[api.ts:2319](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2319) diff --git a/packages/insights/doc/modules.md b/packages/insights/doc/modules.md deleted file mode 100644 index 3b8b313b7..000000000 --- a/packages/insights/doc/modules.md +++ /dev/null @@ -1,2148 +0,0 @@ -[@redhat-cloud-services/insights-client](README.md) / Exports - -# @redhat-cloud-services/insights-client - -## Table of contents - -### Enumerations - -- [AllRuleRatingsRatingEnum](enums/AllRuleRatingsRatingEnum.md) -- [RuleRatingRatingEnum](enums/RuleRatingRatingEnum.md) - -### Classes - -- [AccountApi](classes/AccountApi.md) -- [AckApi](classes/AckApi.md) -- [AckcountApi](classes/AckcountApi.md) -- [AutosubexclusionApi](classes/AutosubexclusionApi.md) -- [Configuration](classes/Configuration.md) -- [ExportApi](classes/ExportApi.md) -- [HostackApi](classes/HostackApi.md) -- [KcsApi](classes/KcsApi.md) -- [PathwayApi](classes/PathwayApi.md) -- [RatingApi](classes/RatingApi.md) -- [RuleApi](classes/RuleApi.md) -- [RulecategoryApi](classes/RulecategoryApi.md) -- [SettingsApi](classes/SettingsApi.md) -- [StatsApi](classes/StatsApi.md) -- [StatusApi](classes/StatusApi.md) -- [SystemApi](classes/SystemApi.md) -- [SystemtypeApi](classes/SystemtypeApi.md) -- [TopicApi](classes/TopicApi.md) -- [UsageApi](classes/UsageApi.md) -- [UserPreferencesApi](classes/UserPreferencesApi.md) -- [WeeklyreportautosubscribeApi](classes/WeeklyreportautosubscribeApi.md) -- [WeeklyreportsubscriptionApi](classes/WeeklyreportsubscriptionApi.md) - -### Interfaces - -- [Ack](interfaces/Ack.md) -- [AckCount](interfaces/AckCount.md) -- [AckInput](interfaces/AckInput.md) -- [AckJustification](interfaces/AckJustification.md) -- [AllAck](interfaces/AllAck.md) -- [AllRuleRatings](interfaces/AllRuleRatings.md) -- [AutoSubscribe](interfaces/AutoSubscribe.md) -- [AutoSubscribeInput](interfaces/AutoSubscribeInput.md) -- [ConfigurationParameters](interfaces/ConfigurationParameters.md) -- [ExportHits](interfaces/ExportHits.md) -- [HostAck](interfaces/HostAck.md) -- [HostAckInput](interfaces/HostAckInput.md) -- [HostAckJustification](interfaces/HostAckJustification.md) -- [JustificationCount](interfaces/JustificationCount.md) -- [Kcs](interfaces/Kcs.md) -- [MultiAckResponse](interfaces/MultiAckResponse.md) -- [MultiHostAck](interfaces/MultiHostAck.md) -- [MultiHostUnAck](interfaces/MultiHostUnAck.md) -- [OrgId](interfaces/OrgId.md) -- [PaginatedAckList](interfaces/PaginatedAckList.md) -- [PaginatedAckListLinks](interfaces/PaginatedAckListLinks.md) -- [PaginatedAckListMeta](interfaces/PaginatedAckListMeta.md) -- [PaginatedAllRuleRatingsList](interfaces/PaginatedAllRuleRatingsList.md) -- [PaginatedHostAckList](interfaces/PaginatedHostAckList.md) -- [PaginatedJustificationCountList](interfaces/PaginatedJustificationCountList.md) -- [PaginatedOrgIdList](interfaces/PaginatedOrgIdList.md) -- [PaginatedPathwayList](interfaces/PaginatedPathwayList.md) -- [PaginatedRuleForAccountList](interfaces/PaginatedRuleForAccountList.md) -- [PaginatedRuleRatingList](interfaces/PaginatedRuleRatingList.md) -- [PaginatedRuleRatingStatsList](interfaces/PaginatedRuleRatingStatsList.md) -- [PaginatedSubscriptionExcludedAccountList](interfaces/PaginatedSubscriptionExcludedAccountList.md) -- [PaginatedSystemList](interfaces/PaginatedSystemList.md) -- [PaginatedSystemsDetailList](interfaces/PaginatedSystemsDetailList.md) -- [PatchedTopicEdit](interfaces/PatchedTopicEdit.md) -- [Pathway](interfaces/Pathway.md) -- [PathwayInput](interfaces/PathwayInput.md) -- [PreferencesInput](interfaces/PreferencesInput.md) -- [RenderedReport](interfaces/RenderedReport.md) -- [Report](interfaces/Report.md) -- [ReportExport](interfaces/ReportExport.md) -- [Resolution](interfaces/Resolution.md) -- [ResolutionRisk](interfaces/ResolutionRisk.md) -- [Rule](interfaces/Rule.md) -- [RuleCategory](interfaces/RuleCategory.md) -- [RuleExport](interfaces/RuleExport.md) -- [RuleForAccount](interfaces/RuleForAccount.md) -- [RuleImpact](interfaces/RuleImpact.md) -- [RulePathway](interfaces/RulePathway.md) -- [RuleRating](interfaces/RuleRating.md) -- [RuleRatingStats](interfaces/RuleRatingStats.md) -- [RuleSystemsExport](interfaces/RuleSystemsExport.md) -- [RuleUsageStats](interfaces/RuleUsageStats.md) -- [SettingDDF](interfaces/SettingDDF.md) -- [SettingsDDF](interfaces/SettingsDDF.md) -- [Stats](interfaces/Stats.md) -- [SubscriptionExcludedAccount](interfaces/SubscriptionExcludedAccount.md) -- [System](interfaces/System.md) -- [SystemType](interfaces/SystemType.md) -- [SystemsDetail](interfaces/SystemsDetail.md) -- [SystemsForRule](interfaces/SystemsForRule.md) -- [Topic](interfaces/Topic.md) -- [TopicEdit](interfaces/TopicEdit.md) -- [Usage](interfaces/Usage.md) -- [WeeklyReportSubscription](interfaces/WeeklyReportSubscription.md) - -### Functions - -- [AccountApiAxiosParamCreator](modules.md#accountapiaxiosparamcreator) -- [AccountApiFactory](modules.md#accountapifactory) -- [AccountApiFp](modules.md#accountapifp) -- [AckApiAxiosParamCreator](modules.md#ackapiaxiosparamcreator) -- [AckApiFactory](modules.md#ackapifactory) -- [AckApiFp](modules.md#ackapifp) -- [AckcountApiAxiosParamCreator](modules.md#ackcountapiaxiosparamcreator) -- [AckcountApiFactory](modules.md#ackcountapifactory) -- [AckcountApiFp](modules.md#ackcountapifp) -- [AutosubexclusionApiAxiosParamCreator](modules.md#autosubexclusionapiaxiosparamcreator) -- [AutosubexclusionApiFactory](modules.md#autosubexclusionapifactory) -- [AutosubexclusionApiFp](modules.md#autosubexclusionapifp) -- [ExportApiAxiosParamCreator](modules.md#exportapiaxiosparamcreator) -- [ExportApiFactory](modules.md#exportapifactory) -- [ExportApiFp](modules.md#exportapifp) -- [HostackApiAxiosParamCreator](modules.md#hostackapiaxiosparamcreator) -- [HostackApiFactory](modules.md#hostackapifactory) -- [HostackApiFp](modules.md#hostackapifp) -- [KcsApiAxiosParamCreator](modules.md#kcsapiaxiosparamcreator) -- [KcsApiFactory](modules.md#kcsapifactory) -- [KcsApiFp](modules.md#kcsapifp) -- [PathwayApiAxiosParamCreator](modules.md#pathwayapiaxiosparamcreator) -- [PathwayApiFactory](modules.md#pathwayapifactory) -- [PathwayApiFp](modules.md#pathwayapifp) -- [RatingApiAxiosParamCreator](modules.md#ratingapiaxiosparamcreator) -- [RatingApiFactory](modules.md#ratingapifactory) -- [RatingApiFp](modules.md#ratingapifp) -- [RuleApiAxiosParamCreator](modules.md#ruleapiaxiosparamcreator) -- [RuleApiFactory](modules.md#ruleapifactory) -- [RuleApiFp](modules.md#ruleapifp) -- [RulecategoryApiAxiosParamCreator](modules.md#rulecategoryapiaxiosparamcreator) -- [RulecategoryApiFactory](modules.md#rulecategoryapifactory) -- [RulecategoryApiFp](modules.md#rulecategoryapifp) -- [SettingsApiAxiosParamCreator](modules.md#settingsapiaxiosparamcreator) -- [SettingsApiFactory](modules.md#settingsapifactory) -- [SettingsApiFp](modules.md#settingsapifp) -- [StatsApiAxiosParamCreator](modules.md#statsapiaxiosparamcreator) -- [StatsApiFactory](modules.md#statsapifactory) -- [StatsApiFp](modules.md#statsapifp) -- [StatusApiAxiosParamCreator](modules.md#statusapiaxiosparamcreator) -- [StatusApiFactory](modules.md#statusapifactory) -- [StatusApiFp](modules.md#statusapifp) -- [SystemApiAxiosParamCreator](modules.md#systemapiaxiosparamcreator) -- [SystemApiFactory](modules.md#systemapifactory) -- [SystemApiFp](modules.md#systemapifp) -- [SystemtypeApiAxiosParamCreator](modules.md#systemtypeapiaxiosparamcreator) -- [SystemtypeApiFactory](modules.md#systemtypeapifactory) -- [SystemtypeApiFp](modules.md#systemtypeapifp) -- [TopicApiAxiosParamCreator](modules.md#topicapiaxiosparamcreator) -- [TopicApiFactory](modules.md#topicapifactory) -- [TopicApiFp](modules.md#topicapifp) -- [UsageApiAxiosParamCreator](modules.md#usageapiaxiosparamcreator) -- [UsageApiFactory](modules.md#usageapifactory) -- [UsageApiFp](modules.md#usageapifp) -- [UserPreferencesApiAxiosParamCreator](modules.md#userpreferencesapiaxiosparamcreator) -- [UserPreferencesApiFactory](modules.md#userpreferencesapifactory) -- [UserPreferencesApiFp](modules.md#userpreferencesapifp) -- [WeeklyreportautosubscribeApiAxiosParamCreator](modules.md#weeklyreportautosubscribeapiaxiosparamcreator) -- [WeeklyreportautosubscribeApiFactory](modules.md#weeklyreportautosubscribeapifactory) -- [WeeklyreportautosubscribeApiFp](modules.md#weeklyreportautosubscribeapifp) -- [WeeklyreportsubscriptionApiAxiosParamCreator](modules.md#weeklyreportsubscriptionapiaxiosparamcreator) -- [WeeklyreportsubscriptionApiFactory](modules.md#weeklyreportsubscriptionapifactory) -- [WeeklyreportsubscriptionApiFp](modules.md#weeklyreportsubscriptionapifp) - -## Functions - -### AccountApiAxiosParamCreator - -▸ **AccountApiAxiosParamCreator**(`configuration?`): `Object` - -AccountApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `accountHostsRetrieve` | (`orgId`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `accountList` | (`limit?`: `number`, `offset?`: `number`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `accountRetrieve` | (`orgId`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:2326](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2326) - -___ - -### AccountApiFactory - -▸ **AccountApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -AccountApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `accountHostsRetrieve` | (`orgId`: `string`, `options?`: `any`) => `AxiosPromise`\<[`OrgId`](interfaces/OrgId.md)\> | -| `accountList` | (`limit?`: `number`, `offset?`: `number`, `options?`: `any`) => `AxiosPromise`\<[`PaginatedOrgIdList`](interfaces/PaginatedOrgIdList.md)\> | -| `accountRetrieve` | (`orgId`: `string`, `options?`: `any`) => `AxiosPromise`\<[`OrgId`](interfaces/OrgId.md)\> | - -**`Export`** - -#### Defined in - -[api.ts:2517](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2517) - -___ - -### AccountApiFp - -▸ **AccountApiFp**(`configuration?`): `Object` - -AccountApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `accountHostsRetrieve` | (`orgId`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`OrgId`](interfaces/OrgId.md)\>\> | -| `accountList` | (`limit?`: `number`, `offset?`: `number`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`PaginatedOrgIdList`](interfaces/PaginatedOrgIdList.md)\>\> | -| `accountRetrieve` | (`orgId`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`OrgId`](interfaces/OrgId.md)\>\> | - -**`Export`** - -#### Defined in - -[api.ts:2468](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2468) - -___ - -### AckApiAxiosParamCreator - -▸ **AckApiAxiosParamCreator**(`configuration?`): `Object` - -AckApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `ackAllList` | (`options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `ackCreate` | (`ackInput`: [`AckInput`](interfaces/AckInput.md), `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `ackDestroy` | (`ruleId`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `ackList` | (`limit?`: `number`, `offset?`: `number`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `ackRetrieve` | (`ruleId`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `ackUpdate` | (`ruleId`: `string`, `ackJustification?`: [`AckJustification`](interfaces/AckJustification.md), `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:2598](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2598) - -___ - -### AckApiFactory - -▸ **AckApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -AckApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `ackAllList` | (`options?`: `any`) => `AxiosPromise`\<[`AllAck`](interfaces/AllAck.md)[]\> | -| `ackCreate` | (`ackInput`: [`AckInput`](interfaces/AckInput.md), `options?`: `any`) => `AxiosPromise`\<[`Ack`](interfaces/Ack.md)\> | -| `ackDestroy` | (`ruleId`: `string`, `options?`: `any`) => `AxiosPromise`\<`string`\> | -| `ackList` | (`limit?`: `number`, `offset?`: `number`, `options?`: `any`) => `AxiosPromise`\<[`PaginatedAckList`](interfaces/PaginatedAckList.md)\> | -| `ackRetrieve` | (`ruleId`: `string`, `options?`: `any`) => `AxiosPromise`\<[`Ack`](interfaces/Ack.md)\> | -| `ackUpdate` | (`ruleId`: `string`, `ackJustification?`: [`AckJustification`](interfaces/AckJustification.md), `options?`: `any`) => `AxiosPromise`\<[`Ack`](interfaces/Ack.md)\> | - -**`Export`** - -#### Defined in - -[api.ts:2959](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2959) - -___ - -### AckApiFp - -▸ **AckApiFp**(`configuration?`): `Object` - -AckApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `ackAllList` | (`options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`AllAck`](interfaces/AllAck.md)[]\>\> | -| `ackCreate` | (`ackInput`: [`AckInput`](interfaces/AckInput.md), `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`Ack`](interfaces/Ack.md)\>\> | -| `ackDestroy` | (`ruleId`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<`string`\>\> | -| `ackList` | (`limit?`: `number`, `offset?`: `number`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`PaginatedAckList`](interfaces/PaginatedAckList.md)\>\> | -| `ackRetrieve` | (`ruleId`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`Ack`](interfaces/Ack.md)\>\> | -| `ackUpdate` | (`ruleId`: `string`, `ackJustification?`: [`AckJustification`](interfaces/AckJustification.md), `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`Ack`](interfaces/Ack.md)\>\> | - -**`Export`** - -#### Defined in - -[api.ts:2871](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L2871) - -___ - -### AckcountApiAxiosParamCreator - -▸ **AckcountApiAxiosParamCreator**(`configuration?`): `Object` - -AckcountApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `ackcountList` | (`options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `ackcountRetrieve` | (`ruleId`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:3100](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L3100) - -___ - -### AckcountApiFactory - -▸ **AckcountApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -AckcountApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `ackcountList` | (`options?`: `any`) => `AxiosPromise`\<[`AckCount`](interfaces/AckCount.md)[]\> | -| `ackcountRetrieve` | (`ruleId`: `string`, `options?`: `any`) => `AxiosPromise`\<[`AckCount`](interfaces/AckCount.md)\> | - -**`Export`** - -#### Defined in - -[api.ts:3223](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L3223) - -___ - -### AckcountApiFp - -▸ **AckcountApiFp**(`configuration?`): `Object` - -AckcountApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `ackcountList` | (`options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`AckCount`](interfaces/AckCount.md)[]\>\> | -| `ackcountRetrieve` | (`ruleId`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`AckCount`](interfaces/AckCount.md)\>\> | - -**`Export`** - -#### Defined in - -[api.ts:3189](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L3189) - -___ - -### AutosubexclusionApiAxiosParamCreator - -▸ **AutosubexclusionApiAxiosParamCreator**(`configuration?`): `Object` - -AutosubexclusionApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `autosubexclusionCreate` | (`subscriptionExcludedAccount`: [`SubscriptionExcludedAccount`](interfaces/SubscriptionExcludedAccount.md), `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `autosubexclusionDestroy` | (`orgId`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `autosubexclusionList` | (`limit?`: `number`, `offset?`: `number`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `autosubexclusionRetrieve` | (`orgId`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:3280](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L3280) - -___ - -### AutosubexclusionApiFactory - -▸ **AutosubexclusionApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -AutosubexclusionApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `autosubexclusionCreate` | (`subscriptionExcludedAccount`: [`SubscriptionExcludedAccount`](interfaces/SubscriptionExcludedAccount.md), `options?`: `any`) => `AxiosPromise`\<[`SubscriptionExcludedAccount`](interfaces/SubscriptionExcludedAccount.md)\> | -| `autosubexclusionDestroy` | (`orgId`: `string`, `options?`: `any`) => `AxiosPromise`\<`string`\> | -| `autosubexclusionList` | (`limit?`: `number`, `offset?`: `number`, `options?`: `any`) => `AxiosPromise`\<[`PaginatedSubscriptionExcludedAccountList`](interfaces/PaginatedSubscriptionExcludedAccountList.md)\> | -| `autosubexclusionRetrieve` | (`orgId`: `string`, `options?`: `any`) => `AxiosPromise`\<[`SubscriptionExcludedAccount`](interfaces/SubscriptionExcludedAccount.md)\> | - -**`Export`** - -#### Defined in - -[api.ts:3530](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L3530) - -___ - -### AutosubexclusionApiFp - -▸ **AutosubexclusionApiFp**(`configuration?`): `Object` - -AutosubexclusionApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `autosubexclusionCreate` | (`subscriptionExcludedAccount`: [`SubscriptionExcludedAccount`](interfaces/SubscriptionExcludedAccount.md), `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`SubscriptionExcludedAccount`](interfaces/SubscriptionExcludedAccount.md)\>\> | -| `autosubexclusionDestroy` | (`orgId`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<`string`\>\> | -| `autosubexclusionList` | (`limit?`: `number`, `offset?`: `number`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`PaginatedSubscriptionExcludedAccountList`](interfaces/PaginatedSubscriptionExcludedAccountList.md)\>\> | -| `autosubexclusionRetrieve` | (`orgId`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`SubscriptionExcludedAccount`](interfaces/SubscriptionExcludedAccount.md)\>\> | - -**`Export`** - -#### Defined in - -[api.ts:3468](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L3468) - -___ - -### ExportApiAxiosParamCreator - -▸ **ExportApiAxiosParamCreator**(`configuration?`): `Object` - -ExportApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `exportHitsList` | (`category?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `displayName?`: `string`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `format?`: ``"csv"`` \| ``"json"``, `groups?`: `string`[], `hasPlaybook?`: `boolean`, `impact?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `incident?`: `boolean`, `likelihood?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `reboot?`: `boolean`, `resRisk?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `tags?`: `string`[], `text?`: `string`, `totalRisk?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `uuid?`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `exportReportsList` | (`category?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `displayName?`: `string`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `hasPlaybook?`: `boolean`, `impact?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `incident?`: `boolean`, `likelihood?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `reboot?`: `boolean`, `resRisk?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `tags?`: `string`[], `text?`: `string`, `totalRisk?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `uuid?`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `exportRulesList` | (`category?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `displayName?`: `string`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `hasPlaybook?`: `boolean`, `impact?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `incident?`: `boolean`, `likelihood?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `reboot?`: `boolean`, `resRisk?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `tags?`: `string`[], `text?`: `string`, `totalRisk?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `uuid?`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `exportSystemsList` | (`displayName?`: `string`, `format?`: ``"csv"`` \| ``"json"``, `groups?`: `string`[], `ruleId?`: `string`, `sort?`: ``"-critical_hits"`` \| ``"-display_name"`` \| ``"-group_name"`` \| ``"-hits"`` \| ``"-important_hits"`` \| ``"-last_seen"`` \| ``"-low_hits"`` \| ``"-moderate_hits"`` \| ``"-rhel_version"`` \| ``"critical_hits"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"hits"`` \| ``"important_hits"`` \| ``"last_seen"`` \| ``"low_hits"`` \| ``"moderate_hits"`` \| ``"rhel_version"``, `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:3631](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L3631) - -___ - -### ExportApiFactory - -▸ **ExportApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -ExportApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `exportHitsList` | (`category?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `displayName?`: `string`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `format?`: ``"csv"`` \| ``"json"``, `groups?`: `string`[], `hasPlaybook?`: `boolean`, `impact?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `incident?`: `boolean`, `likelihood?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `reboot?`: `boolean`, `resRisk?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `tags?`: `string`[], `text?`: `string`, `totalRisk?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `uuid?`: `string`, `options?`: `any`) => `AxiosPromise`\<[`ExportHits`](interfaces/ExportHits.md)[]\> | -| `exportReportsList` | (`category?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `displayName?`: `string`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `hasPlaybook?`: `boolean`, `impact?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `incident?`: `boolean`, `likelihood?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `reboot?`: `boolean`, `resRisk?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `tags?`: `string`[], `text?`: `string`, `totalRisk?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `uuid?`: `string`, `options?`: `any`) => `AxiosPromise`\<[`ReportExport`](interfaces/ReportExport.md)[]\> | -| `exportRulesList` | (`category?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `displayName?`: `string`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `hasPlaybook?`: `boolean`, `impact?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `incident?`: `boolean`, `likelihood?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `reboot?`: `boolean`, `resRisk?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `tags?`: `string`[], `text?`: `string`, `totalRisk?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `uuid?`: `string`, `options?`: `any`) => `AxiosPromise`\<[`RuleExport`](interfaces/RuleExport.md)[]\> | -| `exportSystemsList` | (`displayName?`: `string`, `format?`: ``"csv"`` \| ``"json"``, `groups?`: `string`[], `ruleId?`: `string`, `sort?`: ``"-critical_hits"`` \| ``"-display_name"`` \| ``"-group_name"`` \| ``"-hits"`` \| ``"-important_hits"`` \| ``"-last_seen"`` \| ``"-low_hits"`` \| ``"-moderate_hits"`` \| ``"-rhel_version"`` \| ``"critical_hits"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"hits"`` \| ``"important_hits"`` \| ``"last_seen"`` \| ``"low_hits"`` \| ``"moderate_hits"`` \| ``"rhel_version"``, `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `AxiosPromise`\<[`System`](interfaces/System.md)[]\> | - -**`Export`** - -#### Defined in - -[api.ts:4175](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L4175) - -___ - -### ExportApiFp - -▸ **ExportApiFp**(`configuration?`): `Object` - -ExportApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `exportHitsList` | (`category?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `displayName?`: `string`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `format?`: ``"csv"`` \| ``"json"``, `groups?`: `string`[], `hasPlaybook?`: `boolean`, `impact?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `incident?`: `boolean`, `likelihood?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `reboot?`: `boolean`, `resRisk?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `tags?`: `string`[], `text?`: `string`, `totalRisk?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `uuid?`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`ExportHits`](interfaces/ExportHits.md)[]\>\> | -| `exportReportsList` | (`category?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `displayName?`: `string`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `hasPlaybook?`: `boolean`, `impact?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `incident?`: `boolean`, `likelihood?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `reboot?`: `boolean`, `resRisk?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `tags?`: `string`[], `text?`: `string`, `totalRisk?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `uuid?`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`ReportExport`](interfaces/ReportExport.md)[]\>\> | -| `exportRulesList` | (`category?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `displayName?`: `string`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `hasPlaybook?`: `boolean`, `impact?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `incident?`: `boolean`, `likelihood?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `reboot?`: `boolean`, `resRisk?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `tags?`: `string`[], `text?`: `string`, `totalRisk?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `uuid?`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`RuleExport`](interfaces/RuleExport.md)[]\>\> | -| `exportSystemsList` | (`displayName?`: `string`, `format?`: ``"csv"`` \| ``"json"``, `groups?`: `string`[], `ruleId?`: `string`, `sort?`: ``"-critical_hits"`` \| ``"-display_name"`` \| ``"-group_name"`` \| ``"-hits"`` \| ``"-important_hits"`` \| ``"-last_seen"`` \| ``"-low_hits"`` \| ``"-moderate_hits"`` \| ``"-rhel_version"`` \| ``"critical_hits"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"hits"`` \| ``"important_hits"`` \| ``"last_seen"`` \| ``"low_hits"`` \| ``"moderate_hits"`` \| ``"rhel_version"``, `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`System`](interfaces/System.md)[]\>\> | - -**`Export`** - -#### Defined in - -[api.ts:4063](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L4063) - -___ - -### HostackApiAxiosParamCreator - -▸ **HostackApiAxiosParamCreator**(`configuration?`): `Object` - -HostackApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `hostackCreate` | (`hostAckInput`: [`HostAckInput`](interfaces/HostAckInput.md), `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `hostackDestroy` | (`id`: `number`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `hostackList` | (`filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `limit?`: `number`, `offset?`: `number`, `ruleId?`: `string`[], `tags?`: `string`[], `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `hostackRetrieve` | (`id`: `number`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `hostackUpdate` | (`id`: `number`, `hostAckJustification?`: [`HostAckJustification`](interfaces/HostAckJustification.md), `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:4376](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L4376) - -___ - -### HostackApiFactory - -▸ **HostackApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -HostackApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `hostackCreate` | (`hostAckInput`: [`HostAckInput`](interfaces/HostAckInput.md), `options?`: `any`) => `AxiosPromise`\<[`HostAck`](interfaces/HostAck.md)\> | -| `hostackDestroy` | (`id`: `number`, `options?`: `any`) => `AxiosPromise`\<`string`\> | -| `hostackList` | (`filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `limit?`: `number`, `offset?`: `number`, `ruleId?`: `string`[], `tags?`: `string`[], `options?`: `any`) => `AxiosPromise`\<[`PaginatedHostAckList`](interfaces/PaginatedHostAckList.md)\> | -| `hostackRetrieve` | (`id`: `number`, `options?`: `any`) => `AxiosPromise`\<[`HostAck`](interfaces/HostAck.md)\> | -| `hostackUpdate` | (`id`: `number`, `hostAckJustification?`: [`HostAckJustification`](interfaces/HostAckJustification.md), `options?`: `any`) => `AxiosPromise`\<[`HostAckJustification`](interfaces/HostAckJustification.md)\> | - -**`Export`** - -#### Defined in - -[api.ts:4718](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L4718) - -___ - -### HostackApiFp - -▸ **HostackApiFp**(`configuration?`): `Object` - -HostackApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `hostackCreate` | (`hostAckInput`: [`HostAckInput`](interfaces/HostAckInput.md), `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`HostAck`](interfaces/HostAck.md)\>\> | -| `hostackDestroy` | (`id`: `number`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<`string`\>\> | -| `hostackList` | (`filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `limit?`: `number`, `offset?`: `number`, `ruleId?`: `string`[], `tags?`: `string`[], `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`PaginatedHostAckList`](interfaces/PaginatedHostAckList.md)\>\> | -| `hostackRetrieve` | (`id`: `number`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`HostAck`](interfaces/HostAck.md)\>\> | -| `hostackUpdate` | (`id`: `number`, `hostAckJustification?`: [`HostAckJustification`](interfaces/HostAckJustification.md), `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`HostAckJustification`](interfaces/HostAckJustification.md)\>\> | - -**`Export`** - -#### Defined in - -[api.ts:4637](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L4637) - -___ - -### KcsApiAxiosParamCreator - -▸ **KcsApiAxiosParamCreator**(`configuration?`): `Object` - -KcsApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `kcsList` | (`nodeIds?`: `string`[], `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `kcsRetrieve` | (`nodeId`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:4851](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L4851) - -___ - -### KcsApiFactory - -▸ **KcsApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -KcsApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `kcsList` | (`nodeIds?`: `string`[], `options?`: `any`) => `AxiosPromise`\<[`Kcs`](interfaces/Kcs.md)[]\> | -| `kcsRetrieve` | (`nodeId`: `string`, `options?`: `any`) => `AxiosPromise`\<`string`[]\> | - -**`Export`** - -#### Defined in - -[api.ts:4964](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L4964) - -___ - -### KcsApiFp - -▸ **KcsApiFp**(`configuration?`): `Object` - -KcsApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `kcsList` | (`nodeIds?`: `string`[], `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`Kcs`](interfaces/Kcs.md)[]\>\> | -| `kcsRetrieve` | (`nodeId`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<`string`[]\>\> | - -**`Export`** - -#### Defined in - -[api.ts:4929](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L4929) - -___ - -### PathwayApiAxiosParamCreator - -▸ **PathwayApiAxiosParamCreator**(`configuration?`): `Object` - -PathwayApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `pathwayCreate` | (`pathwayInput`: [`PathwayInput`](interfaces/PathwayInput.md), `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `pathwayDestroy` | (`slug`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `pathwayList` | (`category?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `filterSystemProfileAnsible?`: `boolean`, `filterSystemProfileMssql?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `hasIncident?`: `boolean`, `impacting?`: `boolean`, `limit?`: `number`, `offset?`: `number`, `rebootRequired?`: `boolean`, `sort?`: ``"-impacted_systems_count"`` \| ``"-name"`` \| ``"-recommendation_level"`` \| ``"impacted_systems_count"`` \| ``"name"`` \| ``"recommendation_level"``, `tags?`: `string`[], `text?`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `pathwayReportsRetrieve` | (`slug`: `string`, `category?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `groups?`: `string`[], `hostId?`: `string`[], `ruleId?`: `string`[], `text?`: `string`, `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `pathwayRetrieve` | (`slug`: `string`, `category?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `filterSystemProfileAnsible?`: `boolean`, `filterSystemProfileMssql?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `tags?`: `string`[], `text?`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `pathwayRulesList` | (`slug`: `string`, `category?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `limit?`: `number`, `offset?`: `number`, `text?`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `pathwaySystemsList` | (`slug`: `string`, `category?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `filterSystemProfileAnsible?`: `boolean`, `filterSystemProfileMssql?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `limit?`: `number`, `offset?`: `number`, `tags?`: `string`[], `text?`: `string`, `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `pathwayUpdate` | (`slug`: `string`, `pathwayInput`: [`PathwayInput`](interfaces/PathwayInput.md), `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:5023](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L5023) - -___ - -### PathwayApiFactory - -▸ **PathwayApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -PathwayApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `pathwayCreate` | (`pathwayInput`: [`PathwayInput`](interfaces/PathwayInput.md), `options?`: `any`) => `AxiosPromise`\<[`PathwayInput`](interfaces/PathwayInput.md)\> | -| `pathwayDestroy` | (`slug`: `string`, `options?`: `any`) => `AxiosPromise`\<`string`\> | -| `pathwayList` | (`category?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `filterSystemProfileAnsible?`: `boolean`, `filterSystemProfileMssql?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `hasIncident?`: `boolean`, `impacting?`: `boolean`, `limit?`: `number`, `offset?`: `number`, `rebootRequired?`: `boolean`, `sort?`: ``"-impacted_systems_count"`` \| ``"-name"`` \| ``"-recommendation_level"`` \| ``"impacted_systems_count"`` \| ``"name"`` \| ``"recommendation_level"``, `tags?`: `string`[], `text?`: `string`, `options?`: `any`) => `AxiosPromise`\<[`PaginatedPathwayList`](interfaces/PaginatedPathwayList.md)\> | -| `pathwayReportsRetrieve` | (`slug`: `string`, `category?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `groups?`: `string`[], `hostId?`: `string`[], `ruleId?`: `string`[], `text?`: `string`, `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `AxiosPromise`\<[`RuleSystemsExport`](interfaces/RuleSystemsExport.md)\> | -| `pathwayRetrieve` | (`slug`: `string`, `category?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `filterSystemProfileAnsible?`: `boolean`, `filterSystemProfileMssql?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `tags?`: `string`[], `text?`: `string`, `options?`: `any`) => `AxiosPromise`\<[`Pathway`](interfaces/Pathway.md)\> | -| `pathwayRulesList` | (`slug`: `string`, `category?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `limit?`: `number`, `offset?`: `number`, `text?`: `string`, `options?`: `any`) => `AxiosPromise`\<[`PaginatedRuleForAccountList`](interfaces/PaginatedRuleForAccountList.md)\> | -| `pathwaySystemsList` | (`slug`: `string`, `category?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `filterSystemProfileAnsible?`: `boolean`, `filterSystemProfileMssql?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `limit?`: `number`, `offset?`: `number`, `tags?`: `string`[], `text?`: `string`, `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `AxiosPromise`\<[`PaginatedSystemList`](interfaces/PaginatedSystemList.md)\> | -| `pathwayUpdate` | (`slug`: `string`, `pathwayInput`: [`PathwayInput`](interfaces/PathwayInput.md), `options?`: `any`) => `AxiosPromise`\<[`PathwayInput`](interfaces/PathwayInput.md)\> | - -**`Export`** - -#### Defined in - -[api.ts:5769](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L5769) - -___ - -### PathwayApiFp - -▸ **PathwayApiFp**(`configuration?`): `Object` - -PathwayApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `pathwayCreate` | (`pathwayInput`: [`PathwayInput`](interfaces/PathwayInput.md), `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`PathwayInput`](interfaces/PathwayInput.md)\>\> | -| `pathwayDestroy` | (`slug`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<`string`\>\> | -| `pathwayList` | (`category?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `filterSystemProfileAnsible?`: `boolean`, `filterSystemProfileMssql?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `hasIncident?`: `boolean`, `impacting?`: `boolean`, `limit?`: `number`, `offset?`: `number`, `rebootRequired?`: `boolean`, `sort?`: ``"-impacted_systems_count"`` \| ``"-name"`` \| ``"-recommendation_level"`` \| ``"impacted_systems_count"`` \| ``"name"`` \| ``"recommendation_level"``, `tags?`: `string`[], `text?`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`PaginatedPathwayList`](interfaces/PaginatedPathwayList.md)\>\> | -| `pathwayReportsRetrieve` | (`slug`: `string`, `category?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `groups?`: `string`[], `hostId?`: `string`[], `ruleId?`: `string`[], `text?`: `string`, `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`RuleSystemsExport`](interfaces/RuleSystemsExport.md)\>\> | -| `pathwayRetrieve` | (`slug`: `string`, `category?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `filterSystemProfileAnsible?`: `boolean`, `filterSystemProfileMssql?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `tags?`: `string`[], `text?`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`Pathway`](interfaces/Pathway.md)\>\> | -| `pathwayRulesList` | (`slug`: `string`, `category?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `limit?`: `number`, `offset?`: `number`, `text?`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`PaginatedRuleForAccountList`](interfaces/PaginatedRuleForAccountList.md)\>\> | -| `pathwaySystemsList` | (`slug`: `string`, `category?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `filterSystemProfileAnsible?`: `boolean`, `filterSystemProfileMssql?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `limit?`: `number`, `offset?`: `number`, `tags?`: `string`[], `text?`: `string`, `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`PaginatedSystemList`](interfaces/PaginatedSystemList.md)\>\> | -| `pathwayUpdate` | (`slug`: `string`, `pathwayInput`: [`PathwayInput`](interfaces/PathwayInput.md), `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`PathwayInput`](interfaces/PathwayInput.md)\>\> | - -**`Export`** - -#### Defined in - -[api.ts:5605](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L5605) - -___ - -### RatingApiAxiosParamCreator - -▸ **RatingApiAxiosParamCreator**(`configuration?`): `Object` - -RatingApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `ratingAllRatingsList` | (`limit?`: `number`, `offset?`: `number`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `ratingCreate` | (`ruleRating`: [`RuleRating`](interfaces/RuleRating.md), `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `ratingList` | (`limit?`: `number`, `offset?`: `number`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `ratingRetrieve` | (`rule`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `ratingStatsList` | (`limit?`: `number`, `offset?`: `number`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:6050](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L6050) - -___ - -### RatingApiFactory - -▸ **RatingApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -RatingApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `ratingAllRatingsList` | (`limit?`: `number`, `offset?`: `number`, `options?`: `any`) => `AxiosPromise`\<[`PaginatedAllRuleRatingsList`](interfaces/PaginatedAllRuleRatingsList.md)\> | -| `ratingCreate` | (`ruleRating`: [`RuleRating`](interfaces/RuleRating.md), `options?`: `any`) => `AxiosPromise`\<[`RuleRating`](interfaces/RuleRating.md)\> | -| `ratingList` | (`limit?`: `number`, `offset?`: `number`, `options?`: `any`) => `AxiosPromise`\<[`PaginatedRuleRatingList`](interfaces/PaginatedRuleRatingList.md)\> | -| `ratingRetrieve` | (`rule`: `string`, `options?`: `any`) => `AxiosPromise`\<[`RuleRating`](interfaces/RuleRating.md)\> | -| `ratingStatsList` | (`limit?`: `number`, `offset?`: `number`, `options?`: `any`) => `AxiosPromise`\<[`PaginatedRuleRatingStatsList`](interfaces/PaginatedRuleRatingStatsList.md)\> | - -**`Export`** - -#### Defined in - -[api.ts:6368](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L6368) - -___ - -### RatingApiFp - -▸ **RatingApiFp**(`configuration?`): `Object` - -RatingApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `ratingAllRatingsList` | (`limit?`: `number`, `offset?`: `number`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`PaginatedAllRuleRatingsList`](interfaces/PaginatedAllRuleRatingsList.md)\>\> | -| `ratingCreate` | (`ruleRating`: [`RuleRating`](interfaces/RuleRating.md), `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`RuleRating`](interfaces/RuleRating.md)\>\> | -| `ratingList` | (`limit?`: `number`, `offset?`: `number`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`PaginatedRuleRatingList`](interfaces/PaginatedRuleRatingList.md)\>\> | -| `ratingRetrieve` | (`rule`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`RuleRating`](interfaces/RuleRating.md)\>\> | -| `ratingStatsList` | (`limit?`: `number`, `offset?`: `number`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`PaginatedRuleRatingStatsList`](interfaces/PaginatedRuleRatingStatsList.md)\>\> | - -**`Export`** - -#### Defined in - -[api.ts:6290](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L6290) - -___ - -### RuleApiAxiosParamCreator - -▸ **RuleApiAxiosParamCreator**(`configuration?`): `Object` - -RuleApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `ruleAckHostsCreate` | (`ruleId`: `string`, `multiHostAck`: [`MultiHostAck`](interfaces/MultiHostAck.md), `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `ruleJustificationsList` | (`ruleId`: `string`, `limit?`: `number`, `offset?`: `number`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `ruleList` | (`category?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `filterSystemProfileAnsible?`: `boolean`, `filterSystemProfileMssql?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `hasPlaybook?`: `boolean`, `hasTag?`: `string`[], `impact?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `impacting?`: `boolean`, `incident?`: `boolean`, `likelihood?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `limit?`: `number`, `offset?`: `number`, `pathway?`: `string`, `reboot?`: `boolean`, `reportsShown?`: `boolean`, `resRisk?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `ruleStatus?`: ``"all"`` \| ``"disabled"`` \| ``"enabled"`` \| ``"rhdisabled"``, `sort?`: (``"-category"`` \| ``"-description"`` \| ``"-impact"`` \| ``"-impacted_count"`` \| ``"-likelihood"`` \| ``"-playbook_count"`` \| ``"-publish_date"`` \| ``"-resolution_risk"`` \| ``"-rule_id"`` \| ``"-total_risk"`` \| ``"category"`` \| ``"description"`` \| ``"impact"`` \| ``"impacted_count"`` \| ``"likelihood"`` \| ``"playbook_count"`` \| ``"publish_date"`` \| ``"resolution_risk"`` \| ``"rule_id"`` \| ``"total_risk"``)[], `tags?`: `string`[], `text?`: `string`, `topic?`: `string`, `totalRisk?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `ruleRetrieve` | (`ruleId`: `string`, `groups?`: `string`[], `tags?`: `string`[], `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `ruleStatsRetrieve` | (`ruleId`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `ruleSystemsDetailList` | (`ruleId`: `string`, `filterSystemProfileAnsible?`: `boolean`, `filterSystemProfileMssql?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `limit?`: `number`, `name?`: `string`, `offset?`: `number`, `rhelVersion?`: (``"6.0"`` \| ``"6.1"`` \| ``"6.10"`` \| ``"6.2"`` \| ``"6.3"`` \| ``"6.4"`` \| ``"6.5"`` \| ``"6.6"`` \| ``"6.7"`` \| ``"6.8"`` \| ``"6.9"`` \| ``"7.0"`` \| ``"7.1"`` \| ``"7.10"`` \| ``"7.2"`` \| ``"7.3"`` \| ``"7.4"`` \| ``"7.5"`` \| ``"7.6"`` \| ``"7.7"`` \| ``"7.8"`` \| ``"7.9"`` \| ``"8.0"`` \| ``"8.1"`` \| ``"8.10"`` \| ``"8.2"`` \| ``"8.3"`` \| ``"8.4"`` \| ``"8.5"`` \| ``"8.6"`` \| ``"8.7"`` \| ``"8.8"`` \| ``"8.9"`` \| ``"9.0"`` \| ``"9.1"`` \| ``"9.2"`` \| ``"9.3"`` \| ``"9.4"`` \| ``"9.5"``)[], `sort?`: ``"-critical_hits"`` \| ``"-display_name"`` \| ``"-group_name"`` \| ``"-hits"`` \| ``"-important_hits"`` \| ``"-last_seen"`` \| ``"-low_hits"`` \| ``"-moderate_hits"`` \| ``"-rhel_version"`` \| ``"critical_hits"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"hits"`` \| ``"important_hits"`` \| ``"last_seen"`` \| ``"low_hits"`` \| ``"moderate_hits"`` \| ``"rhel_version"`` \| ``"-impacted_date"`` \| ``"impacted_date"``, `tags?`: `string`[], `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `ruleSystemsRetrieve` | (`ruleId`: `string`, `filterSystemProfileAnsible?`: `boolean`, `filterSystemProfileMssql?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `format?`: ``"csv"`` \| ``"json"``, `groups?`: `string`[], `name?`: `string`, `rhelVersion?`: (``"6.0"`` \| ``"6.1"`` \| ``"6.10"`` \| ``"6.2"`` \| ``"6.3"`` \| ``"6.4"`` \| ``"6.5"`` \| ``"6.6"`` \| ``"6.7"`` \| ``"6.8"`` \| ``"6.9"`` \| ``"7.0"`` \| ``"7.1"`` \| ``"7.10"`` \| ``"7.2"`` \| ``"7.3"`` \| ``"7.4"`` \| ``"7.5"`` \| ``"7.6"`` \| ``"7.7"`` \| ``"7.8"`` \| ``"7.9"`` \| ``"8.0"`` \| ``"8.1"`` \| ``"8.10"`` \| ``"8.2"`` \| ``"8.3"`` \| ``"8.4"`` \| ``"8.5"`` \| ``"8.6"`` \| ``"8.7"`` \| ``"8.8"`` \| ``"8.9"`` \| ``"9.0"`` \| ``"9.1"`` \| ``"9.2"`` \| ``"9.3"`` \| ``"9.4"`` \| ``"9.5"``)[], `sort?`: (``"-display_name"`` \| ``"-last_seen"`` \| ``"display_name"`` \| ``"last_seen"`` \| ``"-stale_at"`` \| ``"-system_uuid"`` \| ``"-updated"`` \| ``"stale_at"`` \| ``"system_uuid"`` \| ``"updated"``)[], `tags?`: `string`[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `ruleUnackHostsCreate` | (`ruleId`: `string`, `multiHostUnAck`: [`MultiHostUnAck`](interfaces/MultiHostUnAck.md), `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:6495](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L6495) - -___ - -### RuleApiFactory - -▸ **RuleApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -RuleApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `ruleAckHostsCreate` | (`ruleId`: `string`, `multiHostAck`: [`MultiHostAck`](interfaces/MultiHostAck.md), `options?`: `any`) => `AxiosPromise`\<[`MultiAckResponse`](interfaces/MultiAckResponse.md)\> | -| `ruleJustificationsList` | (`ruleId`: `string`, `limit?`: `number`, `offset?`: `number`, `options?`: `any`) => `AxiosPromise`\<[`PaginatedJustificationCountList`](interfaces/PaginatedJustificationCountList.md)\> | -| `ruleList` | (`category?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `filterSystemProfileAnsible?`: `boolean`, `filterSystemProfileMssql?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `hasPlaybook?`: `boolean`, `hasTag?`: `string`[], `impact?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `impacting?`: `boolean`, `incident?`: `boolean`, `likelihood?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `limit?`: `number`, `offset?`: `number`, `pathway?`: `string`, `reboot?`: `boolean`, `reportsShown?`: `boolean`, `resRisk?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `ruleStatus?`: ``"all"`` \| ``"disabled"`` \| ``"enabled"`` \| ``"rhdisabled"``, `sort?`: (``"-category"`` \| ``"-description"`` \| ``"-impact"`` \| ``"-impacted_count"`` \| ``"-likelihood"`` \| ``"-playbook_count"`` \| ``"-publish_date"`` \| ``"-resolution_risk"`` \| ``"-rule_id"`` \| ``"-total_risk"`` \| ``"category"`` \| ``"description"`` \| ``"impact"`` \| ``"impacted_count"`` \| ``"likelihood"`` \| ``"playbook_count"`` \| ``"publish_date"`` \| ``"resolution_risk"`` \| ``"rule_id"`` \| ``"total_risk"``)[], `tags?`: `string`[], `text?`: `string`, `topic?`: `string`, `totalRisk?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `AxiosPromise`\<[`PaginatedRuleForAccountList`](interfaces/PaginatedRuleForAccountList.md)\> | -| `ruleRetrieve` | (`ruleId`: `string`, `groups?`: `string`[], `tags?`: `string`[], `options?`: `any`) => `AxiosPromise`\<[`RuleForAccount`](interfaces/RuleForAccount.md)\> | -| `ruleStatsRetrieve` | (`ruleId`: `string`, `options?`: `any`) => `AxiosPromise`\<[`RuleUsageStats`](interfaces/RuleUsageStats.md)\> | -| `ruleSystemsDetailList` | (`ruleId`: `string`, `filterSystemProfileAnsible?`: `boolean`, `filterSystemProfileMssql?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `limit?`: `number`, `name?`: `string`, `offset?`: `number`, `rhelVersion?`: (``"6.0"`` \| ``"6.1"`` \| ``"6.10"`` \| ``"6.2"`` \| ``"6.3"`` \| ``"6.4"`` \| ``"6.5"`` \| ``"6.6"`` \| ``"6.7"`` \| ``"6.8"`` \| ``"6.9"`` \| ``"7.0"`` \| ``"7.1"`` \| ``"7.10"`` \| ``"7.2"`` \| ``"7.3"`` \| ``"7.4"`` \| ``"7.5"`` \| ``"7.6"`` \| ``"7.7"`` \| ``"7.8"`` \| ``"7.9"`` \| ``"8.0"`` \| ``"8.1"`` \| ``"8.10"`` \| ``"8.2"`` \| ``"8.3"`` \| ``"8.4"`` \| ``"8.5"`` \| ``"8.6"`` \| ``"8.7"`` \| ``"8.8"`` \| ``"8.9"`` \| ``"9.0"`` \| ``"9.1"`` \| ``"9.2"`` \| ``"9.3"`` \| ``"9.4"`` \| ``"9.5"``)[], `sort?`: ``"-critical_hits"`` \| ``"-display_name"`` \| ``"-group_name"`` \| ``"-hits"`` \| ``"-important_hits"`` \| ``"-last_seen"`` \| ``"-low_hits"`` \| ``"-moderate_hits"`` \| ``"-rhel_version"`` \| ``"critical_hits"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"hits"`` \| ``"important_hits"`` \| ``"last_seen"`` \| ``"low_hits"`` \| ``"moderate_hits"`` \| ``"rhel_version"`` \| ``"-impacted_date"`` \| ``"impacted_date"``, `tags?`: `string`[], `options?`: `any`) => `AxiosPromise`\<[`PaginatedSystemsDetailList`](interfaces/PaginatedSystemsDetailList.md)\> | -| `ruleSystemsRetrieve` | (`ruleId`: `string`, `filterSystemProfileAnsible?`: `boolean`, `filterSystemProfileMssql?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `format?`: ``"csv"`` \| ``"json"``, `groups?`: `string`[], `name?`: `string`, `rhelVersion?`: (``"6.0"`` \| ``"6.1"`` \| ``"6.10"`` \| ``"6.2"`` \| ``"6.3"`` \| ``"6.4"`` \| ``"6.5"`` \| ``"6.6"`` \| ``"6.7"`` \| ``"6.8"`` \| ``"6.9"`` \| ``"7.0"`` \| ``"7.1"`` \| ``"7.10"`` \| ``"7.2"`` \| ``"7.3"`` \| ``"7.4"`` \| ``"7.5"`` \| ``"7.6"`` \| ``"7.7"`` \| ``"7.8"`` \| ``"7.9"`` \| ``"8.0"`` \| ``"8.1"`` \| ``"8.10"`` \| ``"8.2"`` \| ``"8.3"`` \| ``"8.4"`` \| ``"8.5"`` \| ``"8.6"`` \| ``"8.7"`` \| ``"8.8"`` \| ``"8.9"`` \| ``"9.0"`` \| ``"9.1"`` \| ``"9.2"`` \| ``"9.3"`` \| ``"9.4"`` \| ``"9.5"``)[], `sort?`: (``"-display_name"`` \| ``"-last_seen"`` \| ``"display_name"`` \| ``"last_seen"`` \| ``"-stale_at"`` \| ``"-system_uuid"`` \| ``"-updated"`` \| ``"stale_at"`` \| ``"system_uuid"`` \| ``"updated"``)[], `tags?`: `string`[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `AxiosPromise`\<[`SystemsForRule`](interfaces/SystemsForRule.md)\> | -| `ruleUnackHostsCreate` | (`ruleId`: `string`, `multiHostUnAck`: [`MultiHostUnAck`](interfaces/MultiHostUnAck.md), `options?`: `any`) => `AxiosPromise`\<[`MultiAckResponse`](interfaces/MultiAckResponse.md)\> | - -**`Export`** - -#### Defined in - -[api.ts:7280](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L7280) - -___ - -### RuleApiFp - -▸ **RuleApiFp**(`configuration?`): `Object` - -RuleApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `ruleAckHostsCreate` | (`ruleId`: `string`, `multiHostAck`: [`MultiHostAck`](interfaces/MultiHostAck.md), `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`MultiAckResponse`](interfaces/MultiAckResponse.md)\>\> | -| `ruleJustificationsList` | (`ruleId`: `string`, `limit?`: `number`, `offset?`: `number`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`PaginatedJustificationCountList`](interfaces/PaginatedJustificationCountList.md)\>\> | -| `ruleList` | (`category?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `filterSystemProfileAnsible?`: `boolean`, `filterSystemProfileMssql?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `hasPlaybook?`: `boolean`, `hasTag?`: `string`[], `impact?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `impacting?`: `boolean`, `incident?`: `boolean`, `likelihood?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `limit?`: `number`, `offset?`: `number`, `pathway?`: `string`, `reboot?`: `boolean`, `reportsShown?`: `boolean`, `resRisk?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `ruleStatus?`: ``"all"`` \| ``"disabled"`` \| ``"enabled"`` \| ``"rhdisabled"``, `sort?`: (``"-category"`` \| ``"-description"`` \| ``"-impact"`` \| ``"-impacted_count"`` \| ``"-likelihood"`` \| ``"-playbook_count"`` \| ``"-publish_date"`` \| ``"-resolution_risk"`` \| ``"-rule_id"`` \| ``"-total_risk"`` \| ``"category"`` \| ``"description"`` \| ``"impact"`` \| ``"impacted_count"`` \| ``"likelihood"`` \| ``"playbook_count"`` \| ``"publish_date"`` \| ``"resolution_risk"`` \| ``"rule_id"`` \| ``"total_risk"``)[], `tags?`: `string`[], `text?`: `string`, `topic?`: `string`, `totalRisk?`: (``1`` \| ``2`` \| ``3`` \| ``4``)[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`PaginatedRuleForAccountList`](interfaces/PaginatedRuleForAccountList.md)\>\> | -| `ruleRetrieve` | (`ruleId`: `string`, `groups?`: `string`[], `tags?`: `string`[], `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`RuleForAccount`](interfaces/RuleForAccount.md)\>\> | -| `ruleStatsRetrieve` | (`ruleId`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`RuleUsageStats`](interfaces/RuleUsageStats.md)\>\> | -| `ruleSystemsDetailList` | (`ruleId`: `string`, `filterSystemProfileAnsible?`: `boolean`, `filterSystemProfileMssql?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `limit?`: `number`, `name?`: `string`, `offset?`: `number`, `rhelVersion?`: (``"6.0"`` \| ``"6.1"`` \| ``"6.10"`` \| ``"6.2"`` \| ``"6.3"`` \| ``"6.4"`` \| ``"6.5"`` \| ``"6.6"`` \| ``"6.7"`` \| ``"6.8"`` \| ``"6.9"`` \| ``"7.0"`` \| ``"7.1"`` \| ``"7.10"`` \| ``"7.2"`` \| ``"7.3"`` \| ``"7.4"`` \| ``"7.5"`` \| ``"7.6"`` \| ``"7.7"`` \| ``"7.8"`` \| ``"7.9"`` \| ``"8.0"`` \| ``"8.1"`` \| ``"8.10"`` \| ``"8.2"`` \| ``"8.3"`` \| ``"8.4"`` \| ``"8.5"`` \| ``"8.6"`` \| ``"8.7"`` \| ``"8.8"`` \| ``"8.9"`` \| ``"9.0"`` \| ``"9.1"`` \| ``"9.2"`` \| ``"9.3"`` \| ``"9.4"`` \| ``"9.5"``)[], `sort?`: ``"-critical_hits"`` \| ``"-display_name"`` \| ``"-group_name"`` \| ``"-hits"`` \| ``"-important_hits"`` \| ``"-last_seen"`` \| ``"-low_hits"`` \| ``"-moderate_hits"`` \| ``"-rhel_version"`` \| ``"critical_hits"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"hits"`` \| ``"important_hits"`` \| ``"last_seen"`` \| ``"low_hits"`` \| ``"moderate_hits"`` \| ``"rhel_version"`` \| ``"-impacted_date"`` \| ``"impacted_date"``, `tags?`: `string`[], `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`PaginatedSystemsDetailList`](interfaces/PaginatedSystemsDetailList.md)\>\> | -| `ruleSystemsRetrieve` | (`ruleId`: `string`, `filterSystemProfileAnsible?`: `boolean`, `filterSystemProfileMssql?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `format?`: ``"csv"`` \| ``"json"``, `groups?`: `string`[], `name?`: `string`, `rhelVersion?`: (``"6.0"`` \| ``"6.1"`` \| ``"6.10"`` \| ``"6.2"`` \| ``"6.3"`` \| ``"6.4"`` \| ``"6.5"`` \| ``"6.6"`` \| ``"6.7"`` \| ``"6.8"`` \| ``"6.9"`` \| ``"7.0"`` \| ``"7.1"`` \| ``"7.10"`` \| ``"7.2"`` \| ``"7.3"`` \| ``"7.4"`` \| ``"7.5"`` \| ``"7.6"`` \| ``"7.7"`` \| ``"7.8"`` \| ``"7.9"`` \| ``"8.0"`` \| ``"8.1"`` \| ``"8.10"`` \| ``"8.2"`` \| ``"8.3"`` \| ``"8.4"`` \| ``"8.5"`` \| ``"8.6"`` \| ``"8.7"`` \| ``"8.8"`` \| ``"8.9"`` \| ``"9.0"`` \| ``"9.1"`` \| ``"9.2"`` \| ``"9.3"`` \| ``"9.4"`` \| ``"9.5"``)[], `sort?`: (``"-display_name"`` \| ``"-last_seen"`` \| ``"display_name"`` \| ``"last_seen"`` \| ``"-stale_at"`` \| ``"-system_uuid"`` \| ``"-updated"`` \| ``"stale_at"`` \| ``"system_uuid"`` \| ``"updated"``)[], `tags?`: `string`[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`SystemsForRule`](interfaces/SystemsForRule.md)\>\> | -| `ruleUnackHostsCreate` | (`ruleId`: `string`, `multiHostUnAck`: [`MultiHostUnAck`](interfaces/MultiHostUnAck.md), `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`MultiAckResponse`](interfaces/MultiAckResponse.md)\>\> | - -**`Export`** - -#### Defined in - -[api.ts:7115](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L7115) - -___ - -### RulecategoryApiAxiosParamCreator - -▸ **RulecategoryApiAxiosParamCreator**(`configuration?`): `Object` - -RulecategoryApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `rulecategoryList` | (`options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `rulecategoryRetrieve` | (`id`: `number`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:7563](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L7563) - -___ - -### RulecategoryApiFactory - -▸ **RulecategoryApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -RulecategoryApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `rulecategoryList` | (`options?`: `any`) => `AxiosPromise`\<[`RuleCategory`](interfaces/RuleCategory.md)[]\> | -| `rulecategoryRetrieve` | (`id`: `number`, `options?`: `any`) => `AxiosPromise`\<[`RuleCategory`](interfaces/RuleCategory.md)\> | - -**`Export`** - -#### Defined in - -[api.ts:7670](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L7670) - -___ - -### RulecategoryApiFp - -▸ **RulecategoryApiFp**(`configuration?`): `Object` - -RulecategoryApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `rulecategoryList` | (`options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`RuleCategory`](interfaces/RuleCategory.md)[]\>\> | -| `rulecategoryRetrieve` | (`id`: `number`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`RuleCategory`](interfaces/RuleCategory.md)\>\> | - -**`Export`** - -#### Defined in - -[api.ts:7636](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L7636) - -___ - -### SettingsApiAxiosParamCreator - -▸ **SettingsApiAxiosParamCreator**(`configuration?`): `Object` - -SettingsApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `settingsList` | (`options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:7727](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L7727) - -___ - -### SettingsApiFactory - -▸ **SettingsApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -SettingsApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `settingsList` | (`options?`: `any`) => `AxiosPromise`\<[`SettingsDDF`](interfaces/SettingsDDF.md)[]\> | - -**`Export`** - -#### Defined in - -[api.ts:7794](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L7794) - -___ - -### SettingsApiFp - -▸ **SettingsApiFp**(`configuration?`): `Object` - -SettingsApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `settingsList` | (`options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`SettingsDDF`](interfaces/SettingsDDF.md)[]\>\> | - -**`Export`** - -#### Defined in - -[api.ts:7773](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L7773) - -___ - -### StatsApiAxiosParamCreator - -▸ **StatsApiAxiosParamCreator**(`configuration?`): `Object` - -StatsApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `statsList` | (`options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `statsOverviewRetrieve` | (`tags?`: `string`[], `groups?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `statsReportsRetrieve` | (`tags?`: `string`[], `groups?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `statsRulesRetrieve` | (`tags?`: `string`[], `groups?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `statsSystemsRetrieve` | (`tags?`: `string`[], `groups?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:7831](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L7831) - -___ - -### StatsApiFactory - -▸ **StatsApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -StatsApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `statsList` | (`options?`: `any`) => `AxiosPromise`\<`string`[][]\> | -| `statsOverviewRetrieve` | (`tags?`: `string`[], `groups?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `options?`: `any`) => `AxiosPromise`\<[`Stats`](interfaces/Stats.md)\> | -| `statsReportsRetrieve` | (`tags?`: `string`[], `groups?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `options?`: `any`) => `AxiosPromise`\<[`Stats`](interfaces/Stats.md)\> | -| `statsRulesRetrieve` | (`tags?`: `string`[], `groups?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `options?`: `any`) => `AxiosPromise`\<[`Stats`](interfaces/Stats.md)\> | -| `statsSystemsRetrieve` | (`tags?`: `string`[], `groups?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `options?`: `any`) => `AxiosPromise`\<[`Stats`](interfaces/Stats.md)\> | - -**`Export`** - -#### Defined in - -[api.ts:8190](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L8190) - -___ - -### StatsApiFp - -▸ **StatsApiFp**(`configuration?`): `Object` - -StatsApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `statsList` | (`options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<`string`[][]\>\> | -| `statsOverviewRetrieve` | (`tags?`: `string`[], `groups?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`Stats`](interfaces/Stats.md)\>\> | -| `statsReportsRetrieve` | (`tags?`: `string`[], `groups?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`Stats`](interfaces/Stats.md)\>\> | -| `statsRulesRetrieve` | (`tags?`: `string`[], `groups?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`Stats`](interfaces/Stats.md)\>\> | -| `statsSystemsRetrieve` | (`tags?`: `string`[], `groups?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`Stats`](interfaces/Stats.md)\>\> | - -**`Export`** - -#### Defined in - -[api.ts:8105](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L8105) - -___ - -### StatusApiAxiosParamCreator - -▸ **StatusApiAxiosParamCreator**(`configuration?`): `Object` - -StatusApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `statusLiveRetrieve` | (`options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `statusReadyRetrieve` | (`options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `statusRetrieve` | (`options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:8331](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L8331) - -___ - -### StatusApiFactory - -▸ **StatusApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -StatusApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `statusLiveRetrieve` | (`options?`: `any`) => `AxiosPromise`\<`void`\> | -| `statusReadyRetrieve` | (`options?`: `any`) => `AxiosPromise`\<`void`\> | -| `statusRetrieve` | (`options?`: `any`) => `AxiosPromise`\<`void`\> | - -**`Export`** - -#### Defined in - -[api.ts:8472](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L8472) - -___ - -### StatusApiFp - -▸ **StatusApiFp**(`configuration?`): `Object` - -StatusApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `statusLiveRetrieve` | (`options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<`void`\>\> | -| `statusReadyRetrieve` | (`options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<`void`\>\> | -| `statusRetrieve` | (`options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<`void`\>\> | - -**`Export`** - -#### Defined in - -[api.ts:8427](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L8427) - -___ - -### SystemApiAxiosParamCreator - -▸ **SystemApiAxiosParamCreator**(`configuration?`): `Object` - -SystemApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `systemList` | (`displayName?`: `string`, `filterSystemProfileAnsible?`: `boolean`, `filterSystemProfileMssql?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `hits?`: (``"all"`` \| ``"1"`` \| ``"2"`` \| ``"3"`` \| ``"4"`` \| ``"no"`` \| ``"yes"``)[], `incident?`: `boolean`, `limit?`: `number`, `offset?`: `number`, `pathway?`: `string`, `rhelVersion?`: (``"6.0"`` \| ``"6.1"`` \| ``"6.10"`` \| ``"6.2"`` \| ``"6.3"`` \| ``"6.4"`` \| ``"6.5"`` \| ``"6.6"`` \| ``"6.7"`` \| ``"6.8"`` \| ``"6.9"`` \| ``"7.0"`` \| ``"7.1"`` \| ``"7.10"`` \| ``"7.2"`` \| ``"7.3"`` \| ``"7.4"`` \| ``"7.5"`` \| ``"7.6"`` \| ``"7.7"`` \| ``"7.8"`` \| ``"7.9"`` \| ``"8.0"`` \| ``"8.1"`` \| ``"8.10"`` \| ``"8.2"`` \| ``"8.3"`` \| ``"8.4"`` \| ``"8.5"`` \| ``"8.6"`` \| ``"8.7"`` \| ``"8.8"`` \| ``"8.9"`` \| ``"9.0"`` \| ``"9.1"`` \| ``"9.2"`` \| ``"9.3"`` \| ``"9.4"`` \| ``"9.5"``)[], `sort?`: ``"-critical_hits"`` \| ``"-display_name"`` \| ``"-group_name"`` \| ``"-hits"`` \| ``"-important_hits"`` \| ``"-last_seen"`` \| ``"-low_hits"`` \| ``"-moderate_hits"`` \| ``"-rhel_version"`` \| ``"critical_hits"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"hits"`` \| ``"important_hits"`` \| ``"last_seen"`` \| ``"low_hits"`` \| ``"moderate_hits"`` \| ``"rhel_version"``, `tags?`: `string`[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `systemRenderedReportsList` | (`uuid`: `string`, `filterSystemProfileAnsible?`: `boolean`, `filterSystemProfileMssql?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `tags?`: `string`[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `systemReportsList` | (`uuid`: `string`, `filterSystemProfileAnsible?`: `boolean`, `filterSystemProfileMssql?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `tags?`: `string`[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `systemRetrieve` | (`uuid`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:8545](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L8545) - -___ - -### SystemApiFactory - -▸ **SystemApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -SystemApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `systemList` | (`displayName?`: `string`, `filterSystemProfileAnsible?`: `boolean`, `filterSystemProfileMssql?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `hits?`: (``"all"`` \| ``"1"`` \| ``"2"`` \| ``"3"`` \| ``"4"`` \| ``"no"`` \| ``"yes"``)[], `incident?`: `boolean`, `limit?`: `number`, `offset?`: `number`, `pathway?`: `string`, `rhelVersion?`: (``"6.0"`` \| ``"6.1"`` \| ``"6.10"`` \| ``"6.2"`` \| ``"6.3"`` \| ``"6.4"`` \| ``"6.5"`` \| ``"6.6"`` \| ``"6.7"`` \| ``"6.8"`` \| ``"6.9"`` \| ``"7.0"`` \| ``"7.1"`` \| ``"7.10"`` \| ``"7.2"`` \| ``"7.3"`` \| ``"7.4"`` \| ``"7.5"`` \| ``"7.6"`` \| ``"7.7"`` \| ``"7.8"`` \| ``"7.9"`` \| ``"8.0"`` \| ``"8.1"`` \| ``"8.10"`` \| ``"8.2"`` \| ``"8.3"`` \| ``"8.4"`` \| ``"8.5"`` \| ``"8.6"`` \| ``"8.7"`` \| ``"8.8"`` \| ``"8.9"`` \| ``"9.0"`` \| ``"9.1"`` \| ``"9.2"`` \| ``"9.3"`` \| ``"9.4"`` \| ``"9.5"``)[], `sort?`: ``"-critical_hits"`` \| ``"-display_name"`` \| ``"-group_name"`` \| ``"-hits"`` \| ``"-important_hits"`` \| ``"-last_seen"`` \| ``"-low_hits"`` \| ``"-moderate_hits"`` \| ``"-rhel_version"`` \| ``"critical_hits"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"hits"`` \| ``"important_hits"`` \| ``"last_seen"`` \| ``"low_hits"`` \| ``"moderate_hits"`` \| ``"rhel_version"``, `tags?`: `string`[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `AxiosPromise`\<[`PaginatedSystemList`](interfaces/PaginatedSystemList.md)\> | -| `systemRenderedReportsList` | (`uuid`: `string`, `filterSystemProfileAnsible?`: `boolean`, `filterSystemProfileMssql?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `tags?`: `string`[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `AxiosPromise`\<[`RenderedReport`](interfaces/RenderedReport.md)[]\> | -| `systemReportsList` | (`uuid`: `string`, `filterSystemProfileAnsible?`: `boolean`, `filterSystemProfileMssql?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `tags?`: `string`[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `AxiosPromise`\<[`Report`](interfaces/Report.md)[]\> | -| `systemRetrieve` | (`uuid`: `string`, `options?`: `any`) => `AxiosPromise`\<[`System`](interfaces/System.md)\> | - -**`Export`** - -#### Defined in - -[api.ts:8950](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L8950) - -___ - -### SystemApiFp - -▸ **SystemApiFp**(`configuration?`): `Object` - -SystemApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `systemList` | (`displayName?`: `string`, `filterSystemProfileAnsible?`: `boolean`, `filterSystemProfileMssql?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `hits?`: (``"all"`` \| ``"1"`` \| ``"2"`` \| ``"3"`` \| ``"4"`` \| ``"no"`` \| ``"yes"``)[], `incident?`: `boolean`, `limit?`: `number`, `offset?`: `number`, `pathway?`: `string`, `rhelVersion?`: (``"6.0"`` \| ``"6.1"`` \| ``"6.10"`` \| ``"6.2"`` \| ``"6.3"`` \| ``"6.4"`` \| ``"6.5"`` \| ``"6.6"`` \| ``"6.7"`` \| ``"6.8"`` \| ``"6.9"`` \| ``"7.0"`` \| ``"7.1"`` \| ``"7.10"`` \| ``"7.2"`` \| ``"7.3"`` \| ``"7.4"`` \| ``"7.5"`` \| ``"7.6"`` \| ``"7.7"`` \| ``"7.8"`` \| ``"7.9"`` \| ``"8.0"`` \| ``"8.1"`` \| ``"8.10"`` \| ``"8.2"`` \| ``"8.3"`` \| ``"8.4"`` \| ``"8.5"`` \| ``"8.6"`` \| ``"8.7"`` \| ``"8.8"`` \| ``"8.9"`` \| ``"9.0"`` \| ``"9.1"`` \| ``"9.2"`` \| ``"9.3"`` \| ``"9.4"`` \| ``"9.5"``)[], `sort?`: ``"-critical_hits"`` \| ``"-display_name"`` \| ``"-group_name"`` \| ``"-hits"`` \| ``"-important_hits"`` \| ``"-last_seen"`` \| ``"-low_hits"`` \| ``"-moderate_hits"`` \| ``"-rhel_version"`` \| ``"critical_hits"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"hits"`` \| ``"important_hits"`` \| ``"last_seen"`` \| ``"low_hits"`` \| ``"moderate_hits"`` \| ``"rhel_version"``, `tags?`: `string`[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`PaginatedSystemList`](interfaces/PaginatedSystemList.md)\>\> | -| `systemRenderedReportsList` | (`uuid`: `string`, `filterSystemProfileAnsible?`: `boolean`, `filterSystemProfileMssql?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `tags?`: `string`[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`RenderedReport`](interfaces/RenderedReport.md)[]\>\> | -| `systemReportsList` | (`uuid`: `string`, `filterSystemProfileAnsible?`: `boolean`, `filterSystemProfileMssql?`: `boolean`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `tags?`: `string`[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`Report`](interfaces/Report.md)[]\>\> | -| `systemRetrieve` | (`uuid`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`System`](interfaces/System.md)\>\> | - -**`Export`** - -#### Defined in - -[api.ts:8861](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L8861) - -___ - -### SystemtypeApiAxiosParamCreator - -▸ **SystemtypeApiAxiosParamCreator**(`configuration?`): `Object` - -SystemtypeApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `systemtypeList` | (`options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `systemtypeRetrieve` | (`id`: `number`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:9105](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L9105) - -___ - -### SystemtypeApiFactory - -▸ **SystemtypeApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -SystemtypeApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `systemtypeList` | (`options?`: `any`) => `AxiosPromise`\<[`SystemType`](interfaces/SystemType.md)[]\> | -| `systemtypeRetrieve` | (`id`: `number`, `options?`: `any`) => `AxiosPromise`\<[`SystemType`](interfaces/SystemType.md)\> | - -**`Export`** - -#### Defined in - -[api.ts:9216](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L9216) - -___ - -### SystemtypeApiFp - -▸ **SystemtypeApiFp**(`configuration?`): `Object` - -SystemtypeApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `systemtypeList` | (`options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`SystemType`](interfaces/SystemType.md)[]\>\> | -| `systemtypeRetrieve` | (`id`: `number`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`SystemType`](interfaces/SystemType.md)\>\> | - -**`Export`** - -#### Defined in - -[api.ts:9180](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L9180) - -___ - -### TopicApiAxiosParamCreator - -▸ **TopicApiAxiosParamCreator**(`configuration?`): `Object` - -TopicApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `topicCreate` | (`topicEdit`: [`TopicEdit`](interfaces/TopicEdit.md), `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `topicDestroy` | (`slug`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `topicList` | (`filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `showDisabled?`: `boolean`, `tags?`: `string`[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `topicPartialUpdate` | (`slug`: `string`, `patchedTopicEdit?`: [`PatchedTopicEdit`](interfaces/PatchedTopicEdit.md), `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `topicRetrieve` | (`slug`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `topicRulesWithTagList` | (`slug`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `topicSystemsRetrieve` | (`slug`: `string`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `sort?`: (``"-display_name"`` \| ``"-last_seen"`` \| ``"display_name"`` \| ``"last_seen"`` \| ``"-stale_at"`` \| ``"-system_uuid"`` \| ``"-updated"`` \| ``"stale_at"`` \| ``"system_uuid"`` \| ``"updated"``)[], `tags?`: `string`[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `topicUpdate` | (`slug`: `string`, `topicEdit`: [`TopicEdit`](interfaces/TopicEdit.md), `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:9277](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L9277) - -___ - -### TopicApiFactory - -▸ **TopicApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -TopicApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `topicCreate` | (`topicEdit`: [`TopicEdit`](interfaces/TopicEdit.md), `options?`: `any`) => `AxiosPromise`\<[`TopicEdit`](interfaces/TopicEdit.md)\> | -| `topicDestroy` | (`slug`: `string`, `options?`: `any`) => `AxiosPromise`\<`void`\> | -| `topicList` | (`filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `showDisabled?`: `boolean`, `tags?`: `string`[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `AxiosPromise`\<[`Topic`](interfaces/Topic.md)[]\> | -| `topicPartialUpdate` | (`slug`: `string`, `patchedTopicEdit?`: [`PatchedTopicEdit`](interfaces/PatchedTopicEdit.md), `options?`: `any`) => `AxiosPromise`\<[`TopicEdit`](interfaces/TopicEdit.md)\> | -| `topicRetrieve` | (`slug`: `string`, `options?`: `any`) => `AxiosPromise`\<[`Topic`](interfaces/Topic.md)\> | -| `topicRulesWithTagList` | (`slug`: `string`, `options?`: `any`) => `AxiosPromise`\<[`Rule`](interfaces/Rule.md)[]\> | -| `topicSystemsRetrieve` | (`slug`: `string`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `sort?`: (``"-display_name"`` \| ``"-last_seen"`` \| ``"display_name"`` \| ``"last_seen"`` \| ``"-stale_at"`` \| ``"-system_uuid"`` \| ``"-updated"`` \| ``"stale_at"`` \| ``"system_uuid"`` \| ``"updated"``)[], `tags?`: `string`[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `AxiosPromise`\<[`SystemsForRule`](interfaces/SystemsForRule.md)\> | -| `topicUpdate` | (`slug`: `string`, `topicEdit`: [`TopicEdit`](interfaces/TopicEdit.md), `options?`: `any`) => `AxiosPromise`\<[`TopicEdit`](interfaces/TopicEdit.md)\> | - -**`Export`** - -#### Defined in - -[api.ts:9835](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L9835) - -___ - -### TopicApiFp - -▸ **TopicApiFp**(`configuration?`): `Object` - -TopicApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `topicCreate` | (`topicEdit`: [`TopicEdit`](interfaces/TopicEdit.md), `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`TopicEdit`](interfaces/TopicEdit.md)\>\> | -| `topicDestroy` | (`slug`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<`void`\>\> | -| `topicList` | (`filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `showDisabled?`: `boolean`, `tags?`: `string`[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`Topic`](interfaces/Topic.md)[]\>\> | -| `topicPartialUpdate` | (`slug`: `string`, `patchedTopicEdit?`: [`PatchedTopicEdit`](interfaces/PatchedTopicEdit.md), `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`TopicEdit`](interfaces/TopicEdit.md)\>\> | -| `topicRetrieve` | (`slug`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`Topic`](interfaces/Topic.md)\>\> | -| `topicRulesWithTagList` | (`slug`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`Rule`](interfaces/Rule.md)[]\>\> | -| `topicSystemsRetrieve` | (`slug`: `string`, `filterSystemProfileSapSidsContains?`: `string`[], `filterSystemProfileSapSystem?`: `boolean`, `groups?`: `string`[], `sort?`: (``"-display_name"`` \| ``"-last_seen"`` \| ``"display_name"`` \| ``"last_seen"`` \| ``"-stale_at"`` \| ``"-system_uuid"`` \| ``"-updated"`` \| ``"stale_at"`` \| ``"system_uuid"`` \| ``"updated"``)[], `tags?`: `string`[], `updateMethod?`: (``"dnfyum"`` \| ``"ostree"``)[], `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`SystemsForRule`](interfaces/SystemsForRule.md)\>\> | -| `topicUpdate` | (`slug`: `string`, `topicEdit`: [`TopicEdit`](interfaces/TopicEdit.md), `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`TopicEdit`](interfaces/TopicEdit.md)\>\> | - -**`Export`** - -#### Defined in - -[api.ts:9705](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L9705) - -___ - -### UsageApiAxiosParamCreator - -▸ **UsageApiAxiosParamCreator**(`configuration?`): `Object` - -UsageApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `usageList` | (`account?`: `string`[], `end?`: `string`, `orgId?`: `string`, `start?`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:10048](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L10048) - -___ - -### UsageApiFactory - -▸ **UsageApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -UsageApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `usageList` | (`account?`: `string`[], `end?`: `string`, `orgId?`: `string`, `start?`: `string`, `options?`: `any`) => `AxiosPromise`\<[`Usage`](interfaces/Usage.md)\> | - -**`Export`** - -#### Defined in - -[api.ts:10143](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L10143) - -___ - -### UsageApiFp - -▸ **UsageApiFp**(`configuration?`): `Object` - -UsageApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `usageList` | (`account?`: `string`[], `end?`: `string`, `orgId?`: `string`, `start?`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`Usage`](interfaces/Usage.md)\>\> | - -**`Export`** - -#### Defined in - -[api.ts:10118](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L10118) - -___ - -### UserPreferencesApiAxiosParamCreator - -▸ **UserPreferencesApiAxiosParamCreator**(`configuration?`): `Object` - -UserPreferencesApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `userPreferencesCreate` | (`preferencesInput`: [`PreferencesInput`](interfaces/PreferencesInput.md), `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `userPreferencesList` | (`options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:10188](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L10188) - -___ - -### UserPreferencesApiFactory - -▸ **UserPreferencesApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -UserPreferencesApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `userPreferencesCreate` | (`preferencesInput`: [`PreferencesInput`](interfaces/PreferencesInput.md), `options?`: `any`) => `AxiosPromise`\<[`PreferencesInput`](interfaces/PreferencesInput.md)\> | -| `userPreferencesList` | (`options?`: `any`) => `AxiosPromise`\<[`SettingsDDF`](interfaces/SettingsDDF.md)[]\> | - -**`Export`** - -#### Defined in - -[api.ts:10314](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L10314) - -___ - -### UserPreferencesApiFp - -▸ **UserPreferencesApiFp**(`configuration?`): `Object` - -UserPreferencesApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `userPreferencesCreate` | (`preferencesInput`: [`PreferencesInput`](interfaces/PreferencesInput.md), `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`PreferencesInput`](interfaces/PreferencesInput.md)\>\> | -| `userPreferencesList` | (`options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`SettingsDDF`](interfaces/SettingsDDF.md)[]\>\> | - -**`Export`** - -#### Defined in - -[api.ts:10280](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L10280) - -___ - -### WeeklyreportautosubscribeApiAxiosParamCreator - -▸ **WeeklyreportautosubscribeApiAxiosParamCreator**(`configuration?`): `Object` - -WeeklyreportautosubscribeApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `weeklyreportautosubscribeCreate` | (`autoSubscribeInput`: [`AutoSubscribeInput`](interfaces/AutoSubscribeInput.md), `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `weeklyreportautosubscribeList` | (`options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:10371](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L10371) - -___ - -### WeeklyreportautosubscribeApiFactory - -▸ **WeeklyreportautosubscribeApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -WeeklyreportautosubscribeApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `weeklyreportautosubscribeCreate` | (`autoSubscribeInput`: [`AutoSubscribeInput`](interfaces/AutoSubscribeInput.md), `options?`: `any`) => `AxiosPromise`\<[`AutoSubscribe`](interfaces/AutoSubscribe.md)\> | -| `weeklyreportautosubscribeList` | (`options?`: `any`) => `AxiosPromise`\<[`AutoSubscribe`](interfaces/AutoSubscribe.md)[]\> | - -**`Export`** - -#### Defined in - -[api.ts:10497](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L10497) - -___ - -### WeeklyreportautosubscribeApiFp - -▸ **WeeklyreportautosubscribeApiFp**(`configuration?`): `Object` - -WeeklyreportautosubscribeApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `weeklyreportautosubscribeCreate` | (`autoSubscribeInput`: [`AutoSubscribeInput`](interfaces/AutoSubscribeInput.md), `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`AutoSubscribe`](interfaces/AutoSubscribe.md)\>\> | -| `weeklyreportautosubscribeList` | (`options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`AutoSubscribe`](interfaces/AutoSubscribe.md)[]\>\> | - -**`Export`** - -#### Defined in - -[api.ts:10463](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L10463) - -___ - -### WeeklyreportsubscriptionApiAxiosParamCreator - -▸ **WeeklyreportsubscriptionApiAxiosParamCreator**(`configuration?`): `Object` - -WeeklyreportsubscriptionApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `weeklyreportsubscriptionCreate` | (`weeklyReportSubscription`: [`WeeklyReportSubscription`](interfaces/WeeklyReportSubscription.md), `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `weeklyreportsubscriptionList` | (`options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:10554](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L10554) - -___ - -### WeeklyreportsubscriptionApiFactory - -▸ **WeeklyreportsubscriptionApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -WeeklyreportsubscriptionApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `weeklyreportsubscriptionCreate` | (`weeklyReportSubscription`: [`WeeklyReportSubscription`](interfaces/WeeklyReportSubscription.md), `options?`: `any`) => `AxiosPromise`\<[`WeeklyReportSubscription`](interfaces/WeeklyReportSubscription.md)\> | -| `weeklyreportsubscriptionList` | (`options?`: `any`) => `AxiosPromise`\<[`WeeklyReportSubscription`](interfaces/WeeklyReportSubscription.md)[]\> | - -**`Export`** - -#### Defined in - -[api.ts:10680](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L10680) - -___ - -### WeeklyreportsubscriptionApiFp - -▸ **WeeklyreportsubscriptionApiFp**(`configuration?`): `Object` - -WeeklyreportsubscriptionApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `weeklyreportsubscriptionCreate` | (`weeklyReportSubscription`: [`WeeklyReportSubscription`](interfaces/WeeklyReportSubscription.md), `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`WeeklyReportSubscription`](interfaces/WeeklyReportSubscription.md)\>\> | -| `weeklyreportsubscriptionList` | (`options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`WeeklyReportSubscription`](interfaces/WeeklyReportSubscription.md)[]\>\> | - -**`Export`** - -#### Defined in - -[api.ts:10646](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/insights/api.ts#L10646) diff --git a/packages/insights/jest.config.ts b/packages/insights/jest.config.ts index c7064a573..00a2102ec 100644 --- a/packages/insights/jest.config.ts +++ b/packages/insights/jest.config.ts @@ -7,4 +7,5 @@ export default { }, moduleFileExtensions: ['ts', 'js', 'html'], coverageDirectory: '../../coverage/packages/insights', + testPathIgnorePatterns: ['/node_modules/','/tests/integration/'], }; diff --git a/packages/insights/package.json b/packages/insights/package.json index 8c1ba559d..e8141eba6 100644 --- a/packages/insights/package.json +++ b/packages/insights/package.json @@ -2,32 +2,32 @@ "name": "@redhat-cloud-services/insights-client", "version": "3.0.7", "description": "", - "main": "./dist/index.js", - "typings": "./dist/index.d.ts", + "main": "./index.js", + "typings": "./index.d.ts", "exports": { ".": { - "types": "./dist/index.d.ts", - "import": "./dist/esm/index.js", - "default": "./dist/index.js" + "types": "./index.d.ts", + "import": "./esm/index.js", + "default": "./index.js" }, "./api": { - "types": "./dist/api.d.ts", - "import": "./dist/esm/api.js", - "default": "./dist/api.js" + "types": "./api.d.ts", + "import": "./esm/api.js", + "default": "./api.js" }, "./*": { - "types": "./dist/*/index.d.ts", - "import": "./dist/esm/*/index.js", - "default": "./dist/*/index.js" + "types": "./*/index.d.ts", + "import": "./esm/*/index.js", + "default": "./*/index.js" } }, "typesVersions": { "*": { "api": [ - "./dist/api.d.ts" + "./api.d.ts" ], "*": [ - "./dist/*/index.d.ts" + "./*/index.d.ts" ] } }, diff --git a/packages/insights/postProcess.sh b/packages/insights/postProcess.sh index 631bc1c1e..3ae1c2a7c 100755 --- a/packages/insights/postProcess.sh +++ b/packages/insights/postProcess.sh @@ -1,4 +1,4 @@ #!/bin/bash -sed -i.bak 's/AnyType/any/g' api.ts -rm api.ts.bak +sed -i.bak 's/AnyType/any/g' src/api.ts +rm src/api.ts.bak diff --git a/packages/insights/project.json b/packages/insights/project.json index 0d2e0c7ec..89a0e96dd 100644 --- a/packages/insights/project.json +++ b/packages/insights/project.json @@ -4,9 +4,14 @@ "sourceRoot": "packages/insights", "projectType": "library", "targets": { + "clean-generate": { + "command": "rm -rf packages/insights/src" + }, "generate": { + "dependsOn": ["clean-generate"], "executor": "@redhat-cloud-services/build-utils:client-generator", "options": { + "outputPath": "packages/insights/src", "postProcess": "./postProcess.sh", "specs": { "default": "https://cloud.redhat.com/api/insights/v1/openapi.json" @@ -14,11 +19,16 @@ "clientName": "InsightsClient" } }, + "clean-build": { + "command": "rm -rf packages/insights/dist" + }, "build": { + "dependsOn": ["clean-build", "^build"], "executor": "@redhat-cloud-services/build-utils:builder", "options": { + "inputPath": "packages/insights/src", "outputPath": "packages/insights/dist", - "main": "packages/insights/index.ts", + "main": "packages/insights/src/index.ts", "esmTsConfig": "packages/insights/tsconfig.esm.json", "cjsTsConfig": "packages/insights/tsconfig.cjs.json" } diff --git a/packages/insights/src/.gitignore b/packages/insights/src/.gitignore new file mode 100644 index 000000000..149b57654 --- /dev/null +++ b/packages/insights/src/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/packages/insights/src/.npmignore b/packages/insights/src/.npmignore new file mode 100644 index 000000000..6b112e4e7 --- /dev/null +++ b/packages/insights/src/.npmignore @@ -0,0 +1,6 @@ +.openapi-generator +node_modules +.openapi-generator-ignore +package-lock.json +*.ts +!*.d.ts diff --git a/packages/insights/src/.openapi-generator-ignore b/packages/insights/src/.openapi-generator-ignore new file mode 100644 index 000000000..7484ee590 --- /dev/null +++ b/packages/insights/src/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/packages/insights/.openapi-generator/FILES b/packages/insights/src/.openapi-generator/FILES similarity index 94% rename from packages/insights/.openapi-generator/FILES rename to packages/insights/src/.openapi-generator/FILES index 035d45da4..407c1d315 100644 --- a/packages/insights/.openapi-generator/FILES +++ b/packages/insights/src/.openapi-generator/FILES @@ -1,5 +1,6 @@ .gitignore .npmignore +.openapi-generator-ignore AckAllList/index.ts AckCreate/index.ts AckDestroy/index.ts @@ -45,7 +46,6 @@ RuleSystemsRetrieve/index.ts RuleUnackHostsCreate/index.ts RulecategoryList/index.ts RulecategoryRetrieve/index.ts -SettingsList/index.ts StatsList/index.ts StatsOverviewRetrieve/index.ts StatsReportsRetrieve/index.ts @@ -59,14 +59,10 @@ SystemReportsList/index.ts SystemRetrieve/index.ts SystemtypeList/index.ts SystemtypeRetrieve/index.ts -TopicCreate/index.ts -TopicDestroy/index.ts TopicList/index.ts -TopicPartialUpdate/index.ts TopicRetrieve/index.ts TopicRulesWithTagList/index.ts TopicSystemsRetrieve/index.ts -TopicUpdate/index.ts UserPreferencesCreate/index.ts UserPreferencesList/index.ts WeeklyreportautosubscribeCreate/index.ts diff --git a/packages/insights/.openapi-generator/VERSION b/packages/insights/src/.openapi-generator/VERSION similarity index 100% rename from packages/insights/.openapi-generator/VERSION rename to packages/insights/src/.openapi-generator/VERSION diff --git a/packages/insights/AckAllList/index.ts b/packages/insights/src/AckAllList/index.ts similarity index 100% rename from packages/insights/AckAllList/index.ts rename to packages/insights/src/AckAllList/index.ts diff --git a/packages/insights/AckCreate/index.ts b/packages/insights/src/AckCreate/index.ts similarity index 100% rename from packages/insights/AckCreate/index.ts rename to packages/insights/src/AckCreate/index.ts diff --git a/packages/insights/AckDestroy/index.ts b/packages/insights/src/AckDestroy/index.ts similarity index 100% rename from packages/insights/AckDestroy/index.ts rename to packages/insights/src/AckDestroy/index.ts diff --git a/packages/insights/AckList/index.ts b/packages/insights/src/AckList/index.ts similarity index 100% rename from packages/insights/AckList/index.ts rename to packages/insights/src/AckList/index.ts diff --git a/packages/insights/AckRetrieve/index.ts b/packages/insights/src/AckRetrieve/index.ts similarity index 100% rename from packages/insights/AckRetrieve/index.ts rename to packages/insights/src/AckRetrieve/index.ts diff --git a/packages/insights/AckUpdate/index.ts b/packages/insights/src/AckUpdate/index.ts similarity index 100% rename from packages/insights/AckUpdate/index.ts rename to packages/insights/src/AckUpdate/index.ts diff --git a/packages/insights/AckcountList/index.ts b/packages/insights/src/AckcountList/index.ts similarity index 74% rename from packages/insights/AckcountList/index.ts rename to packages/insights/src/AckcountList/index.ts index b01d4e8ec..d15f5594f 100644 --- a/packages/insights/AckcountList/index.ts +++ b/packages/insights/src/AckcountList/index.ts @@ -8,26 +8,14 @@ import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/b import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; // @ts-ignore -import type { PaginatedAckCountList } from '../types'; +import type { AckCount } from '../types'; export type AckcountListParams = { - /** - * Number of results to return per page. - * @type { number } - * @memberof AckcountListApi - */ - limit?: number, - /** - * The initial index from which to return the results. - * @type { number } - * @memberof AckcountListApi - */ - offset?: number, options?: AxiosRequestConfig } -export type AckcountListReturnType = PaginatedAckCountList; +export type AckcountListReturnType = Array; const isAckcountListObjectParams = (params: [AckcountListParams] | unknown[]): params is [AckcountListParams] => { const l = params.length === 1 @@ -42,9 +30,9 @@ const isAckcountListObjectParams = (params: [AckcountListParams] | unknown[]): p * @param {*} [options] Override http request option. * @throws {RequiredError} */ -export const ackcountListParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([AckcountListParams] | [number, number, AxiosRequestConfig])) => { - const params = isAckcountListObjectParams(config) ? config[0] : ['limit', 'offset', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as AckcountListParams; - const { limit, offset, options = {} } = params; +export const ackcountListParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([AckcountListParams] | [AxiosRequestConfig])) => { + const params = isAckcountListObjectParams(config) ? config[0] : ['options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as AckcountListParams; + const { options = {} } = params; const localVarPath = `/api/insights/v1/ackcount/`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -52,14 +40,6 @@ export const ackcountListParamCreator = async (sendRequest: BaseAPI["sendRequest const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - setSearchParams(localVarUrlObj, localVarQueryParameter); diff --git a/packages/insights/AckcountRetrieve/index.ts b/packages/insights/src/AckcountRetrieve/index.ts similarity index 100% rename from packages/insights/AckcountRetrieve/index.ts rename to packages/insights/src/AckcountRetrieve/index.ts diff --git a/packages/insights/AutosubexclusionCreate/index.ts b/packages/insights/src/AutosubexclusionCreate/index.ts similarity index 100% rename from packages/insights/AutosubexclusionCreate/index.ts rename to packages/insights/src/AutosubexclusionCreate/index.ts diff --git a/packages/insights/AutosubexclusionDestroy/index.ts b/packages/insights/src/AutosubexclusionDestroy/index.ts similarity index 100% rename from packages/insights/AutosubexclusionDestroy/index.ts rename to packages/insights/src/AutosubexclusionDestroy/index.ts diff --git a/packages/insights/AutosubexclusionList/index.ts b/packages/insights/src/AutosubexclusionList/index.ts similarity index 100% rename from packages/insights/AutosubexclusionList/index.ts rename to packages/insights/src/AutosubexclusionList/index.ts diff --git a/packages/insights/AutosubexclusionRetrieve/index.ts b/packages/insights/src/AutosubexclusionRetrieve/index.ts similarity index 100% rename from packages/insights/AutosubexclusionRetrieve/index.ts rename to packages/insights/src/AutosubexclusionRetrieve/index.ts diff --git a/packages/insights/DisabledRulesList/index.ts b/packages/insights/src/DisabledRulesList/index.ts similarity index 100% rename from packages/insights/DisabledRulesList/index.ts rename to packages/insights/src/DisabledRulesList/index.ts diff --git a/packages/insights/DisabledRulesRetrieve/index.ts b/packages/insights/src/DisabledRulesRetrieve/index.ts similarity index 100% rename from packages/insights/DisabledRulesRetrieve/index.ts rename to packages/insights/src/DisabledRulesRetrieve/index.ts diff --git a/packages/insights/ExportHitsList/index.ts b/packages/insights/src/ExportHitsList/index.ts similarity index 93% rename from packages/insights/ExportHitsList/index.ts rename to packages/insights/src/ExportHitsList/index.ts index d0b83df70..1107c45a8 100644 --- a/packages/insights/ExportHitsList/index.ts +++ b/packages/insights/src/ExportHitsList/index.ts @@ -97,6 +97,12 @@ export type ExportHitsListParams = { */ text?: string, /** + * Display rules in this topic (slug) + * @type { string } + * @memberof ExportHitsListApi + */ + topic?: string, + /** * Display rules with this total risk level (1..4) * @type { Array } * @memberof ExportHitsListApi @@ -205,9 +211,9 @@ const isExportHitsListObjectParams = (params: [ExportHitsListParams] | unknown[] * @param {*} [options] Override http request option. * @throws {RequiredError} */ -export const exportHitsListParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ExportHitsListParams] | [Array, string, Array, boolean, ExportHitsListFormatEnum, Array, boolean, Array, boolean, Array, boolean, Array, Array, string, Array, Array, string, AxiosRequestConfig])) => { - const params = isExportHitsListObjectParams(config) ? config[0] : ['category', 'displayName', 'filterSystemProfileSapSidsContains', 'filterSystemProfileSapSystem', 'format', 'groups', 'hasPlaybook', 'impact', 'incident', 'likelihood', 'reboot', 'resRisk', 'tags', 'text', 'totalRisk', 'updateMethod', 'uuid', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ExportHitsListParams; - const { category, displayName, filterSystemProfileSapSidsContains, filterSystemProfileSapSystem, format, groups, hasPlaybook, impact, incident, likelihood, reboot, resRisk, tags, text, totalRisk, updateMethod, uuid, options = {} } = params; +export const exportHitsListParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ExportHitsListParams] | [Array, string, Array, boolean, ExportHitsListFormatEnum, Array, boolean, Array, boolean, Array, boolean, Array, Array, string, string, Array, Array, string, AxiosRequestConfig])) => { + const params = isExportHitsListObjectParams(config) ? config[0] : ['category', 'displayName', 'filterSystemProfileSapSidsContains', 'filterSystemProfileSapSystem', 'format', 'groups', 'hasPlaybook', 'impact', 'incident', 'likelihood', 'reboot', 'resRisk', 'tags', 'text', 'topic', 'totalRisk', 'updateMethod', 'uuid', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ExportHitsListParams; + const { category, displayName, filterSystemProfileSapSidsContains, filterSystemProfileSapSystem, format, groups, hasPlaybook, impact, incident, likelihood, reboot, resRisk, tags, text, topic, totalRisk, updateMethod, uuid, options = {} } = params; const localVarPath = `/api/insights/v1/export/hits/`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -271,6 +277,10 @@ export const exportHitsListParamCreator = async (sendRequest: BaseAPI["sendReque localVarQueryParameter['text'] = text; } + if (topic !== undefined) { + localVarQueryParameter['topic'] = topic; + } + if (totalRisk) { localVarQueryParameter['total_risk'] = totalRisk; } diff --git a/packages/insights/ExportReportsList/index.ts b/packages/insights/src/ExportReportsList/index.ts similarity index 93% rename from packages/insights/ExportReportsList/index.ts rename to packages/insights/src/ExportReportsList/index.ts index 9d9b230f9..f3a9600de 100644 --- a/packages/insights/ExportReportsList/index.ts +++ b/packages/insights/src/ExportReportsList/index.ts @@ -91,6 +91,12 @@ export type ExportReportsListParams = { */ text?: string, /** + * Display rules in this topic (slug) + * @type { string } + * @memberof ExportReportsListApi + */ + topic?: string, + /** * Display rules with this total risk level (1..4) * @type { Array } * @memberof ExportReportsListApi @@ -190,9 +196,9 @@ const isExportReportsListObjectParams = (params: [ExportReportsListParams] | unk * @param {*} [options] Override http request option. * @throws {RequiredError} */ -export const exportReportsListParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ExportReportsListParams] | [Array, string, Array, boolean, Array, boolean, Array, boolean, Array, boolean, Array, Array, string, Array, Array, string, AxiosRequestConfig])) => { - const params = isExportReportsListObjectParams(config) ? config[0] : ['category', 'displayName', 'filterSystemProfileSapSidsContains', 'filterSystemProfileSapSystem', 'groups', 'hasPlaybook', 'impact', 'incident', 'likelihood', 'reboot', 'resRisk', 'tags', 'text', 'totalRisk', 'updateMethod', 'uuid', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ExportReportsListParams; - const { category, displayName, filterSystemProfileSapSidsContains, filterSystemProfileSapSystem, groups, hasPlaybook, impact, incident, likelihood, reboot, resRisk, tags, text, totalRisk, updateMethod, uuid, options = {} } = params; +export const exportReportsListParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ExportReportsListParams] | [Array, string, Array, boolean, Array, boolean, Array, boolean, Array, boolean, Array, Array, string, string, Array, Array, string, AxiosRequestConfig])) => { + const params = isExportReportsListObjectParams(config) ? config[0] : ['category', 'displayName', 'filterSystemProfileSapSidsContains', 'filterSystemProfileSapSystem', 'groups', 'hasPlaybook', 'impact', 'incident', 'likelihood', 'reboot', 'resRisk', 'tags', 'text', 'topic', 'totalRisk', 'updateMethod', 'uuid', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ExportReportsListParams; + const { category, displayName, filterSystemProfileSapSidsContains, filterSystemProfileSapSystem, groups, hasPlaybook, impact, incident, likelihood, reboot, resRisk, tags, text, topic, totalRisk, updateMethod, uuid, options = {} } = params; const localVarPath = `/api/insights/v1/export/reports/`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -252,6 +258,10 @@ export const exportReportsListParamCreator = async (sendRequest: BaseAPI["sendRe localVarQueryParameter['text'] = text; } + if (topic !== undefined) { + localVarQueryParameter['topic'] = topic; + } + if (totalRisk) { localVarQueryParameter['total_risk'] = totalRisk; } diff --git a/packages/insights/ExportRulesList/index.ts b/packages/insights/src/ExportRulesList/index.ts similarity index 93% rename from packages/insights/ExportRulesList/index.ts rename to packages/insights/src/ExportRulesList/index.ts index 485563a8e..9106a2b65 100644 --- a/packages/insights/ExportRulesList/index.ts +++ b/packages/insights/src/ExportRulesList/index.ts @@ -91,6 +91,12 @@ export type ExportRulesListParams = { */ text?: string, /** + * Display rules in this topic (slug) + * @type { string } + * @memberof ExportRulesListApi + */ + topic?: string, + /** * Display rules with this total risk level (1..4) * @type { Array } * @memberof ExportRulesListApi @@ -190,9 +196,9 @@ const isExportRulesListObjectParams = (params: [ExportRulesListParams] | unknown * @param {*} [options] Override http request option. * @throws {RequiredError} */ -export const exportRulesListParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ExportRulesListParams] | [Array, string, Array, boolean, Array, boolean, Array, boolean, Array, boolean, Array, Array, string, Array, Array, string, AxiosRequestConfig])) => { - const params = isExportRulesListObjectParams(config) ? config[0] : ['category', 'displayName', 'filterSystemProfileSapSidsContains', 'filterSystemProfileSapSystem', 'groups', 'hasPlaybook', 'impact', 'incident', 'likelihood', 'reboot', 'resRisk', 'tags', 'text', 'totalRisk', 'updateMethod', 'uuid', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ExportRulesListParams; - const { category, displayName, filterSystemProfileSapSidsContains, filterSystemProfileSapSystem, groups, hasPlaybook, impact, incident, likelihood, reboot, resRisk, tags, text, totalRisk, updateMethod, uuid, options = {} } = params; +export const exportRulesListParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ExportRulesListParams] | [Array, string, Array, boolean, Array, boolean, Array, boolean, Array, boolean, Array, Array, string, string, Array, Array, string, AxiosRequestConfig])) => { + const params = isExportRulesListObjectParams(config) ? config[0] : ['category', 'displayName', 'filterSystemProfileSapSidsContains', 'filterSystemProfileSapSystem', 'groups', 'hasPlaybook', 'impact', 'incident', 'likelihood', 'reboot', 'resRisk', 'tags', 'text', 'topic', 'totalRisk', 'updateMethod', 'uuid', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ExportRulesListParams; + const { category, displayName, filterSystemProfileSapSidsContains, filterSystemProfileSapSystem, groups, hasPlaybook, impact, incident, likelihood, reboot, resRisk, tags, text, topic, totalRisk, updateMethod, uuid, options = {} } = params; const localVarPath = `/api/insights/v1/export/rules/`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -252,6 +258,10 @@ export const exportRulesListParamCreator = async (sendRequest: BaseAPI["sendRequ localVarQueryParameter['text'] = text; } + if (topic !== undefined) { + localVarQueryParameter['topic'] = topic; + } + if (totalRisk) { localVarQueryParameter['total_risk'] = totalRisk; } diff --git a/packages/insights/ExportSystemsList/index.ts b/packages/insights/src/ExportSystemsList/index.ts similarity index 100% rename from packages/insights/ExportSystemsList/index.ts rename to packages/insights/src/ExportSystemsList/index.ts diff --git a/packages/insights/HostackCreate/index.ts b/packages/insights/src/HostackCreate/index.ts similarity index 100% rename from packages/insights/HostackCreate/index.ts rename to packages/insights/src/HostackCreate/index.ts diff --git a/packages/insights/HostackDestroy/index.ts b/packages/insights/src/HostackDestroy/index.ts similarity index 100% rename from packages/insights/HostackDestroy/index.ts rename to packages/insights/src/HostackDestroy/index.ts diff --git a/packages/insights/HostackList/index.ts b/packages/insights/src/HostackList/index.ts similarity index 100% rename from packages/insights/HostackList/index.ts rename to packages/insights/src/HostackList/index.ts diff --git a/packages/insights/HostackRetrieve/index.ts b/packages/insights/src/HostackRetrieve/index.ts similarity index 100% rename from packages/insights/HostackRetrieve/index.ts rename to packages/insights/src/HostackRetrieve/index.ts diff --git a/packages/insights/HostackUpdate/index.ts b/packages/insights/src/HostackUpdate/index.ts similarity index 100% rename from packages/insights/HostackUpdate/index.ts rename to packages/insights/src/HostackUpdate/index.ts diff --git a/packages/insights/KcsList/index.ts b/packages/insights/src/KcsList/index.ts similarity index 100% rename from packages/insights/KcsList/index.ts rename to packages/insights/src/KcsList/index.ts diff --git a/packages/insights/KcsRetrieve/index.ts b/packages/insights/src/KcsRetrieve/index.ts similarity index 100% rename from packages/insights/KcsRetrieve/index.ts rename to packages/insights/src/KcsRetrieve/index.ts diff --git a/packages/insights/PathwayList/index.ts b/packages/insights/src/PathwayList/index.ts similarity index 100% rename from packages/insights/PathwayList/index.ts rename to packages/insights/src/PathwayList/index.ts diff --git a/packages/insights/PathwayReportsRetrieve/index.ts b/packages/insights/src/PathwayReportsRetrieve/index.ts similarity index 100% rename from packages/insights/PathwayReportsRetrieve/index.ts rename to packages/insights/src/PathwayReportsRetrieve/index.ts diff --git a/packages/insights/PathwayRetrieve/index.ts b/packages/insights/src/PathwayRetrieve/index.ts similarity index 100% rename from packages/insights/PathwayRetrieve/index.ts rename to packages/insights/src/PathwayRetrieve/index.ts diff --git a/packages/insights/PathwayRulesList/index.ts b/packages/insights/src/PathwayRulesList/index.ts similarity index 100% rename from packages/insights/PathwayRulesList/index.ts rename to packages/insights/src/PathwayRulesList/index.ts diff --git a/packages/insights/PathwaySystemsList/index.ts b/packages/insights/src/PathwaySystemsList/index.ts similarity index 100% rename from packages/insights/PathwaySystemsList/index.ts rename to packages/insights/src/PathwaySystemsList/index.ts diff --git a/packages/insights/RatingAllRatingsList/index.ts b/packages/insights/src/RatingAllRatingsList/index.ts similarity index 100% rename from packages/insights/RatingAllRatingsList/index.ts rename to packages/insights/src/RatingAllRatingsList/index.ts diff --git a/packages/insights/RatingCreate/index.ts b/packages/insights/src/RatingCreate/index.ts similarity index 100% rename from packages/insights/RatingCreate/index.ts rename to packages/insights/src/RatingCreate/index.ts diff --git a/packages/insights/RatingList/index.ts b/packages/insights/src/RatingList/index.ts similarity index 100% rename from packages/insights/RatingList/index.ts rename to packages/insights/src/RatingList/index.ts diff --git a/packages/insights/RatingRetrieve/index.ts b/packages/insights/src/RatingRetrieve/index.ts similarity index 100% rename from packages/insights/RatingRetrieve/index.ts rename to packages/insights/src/RatingRetrieve/index.ts diff --git a/packages/insights/RatingStatsList/index.ts b/packages/insights/src/RatingStatsList/index.ts similarity index 100% rename from packages/insights/RatingStatsList/index.ts rename to packages/insights/src/RatingStatsList/index.ts diff --git a/packages/insights/RuleAckHostsCreate/index.ts b/packages/insights/src/RuleAckHostsCreate/index.ts similarity index 100% rename from packages/insights/RuleAckHostsCreate/index.ts rename to packages/insights/src/RuleAckHostsCreate/index.ts diff --git a/packages/insights/RuleJustificationsList/index.ts b/packages/insights/src/RuleJustificationsList/index.ts similarity index 100% rename from packages/insights/RuleJustificationsList/index.ts rename to packages/insights/src/RuleJustificationsList/index.ts diff --git a/packages/insights/RuleList/index.ts b/packages/insights/src/RuleList/index.ts similarity index 100% rename from packages/insights/RuleList/index.ts rename to packages/insights/src/RuleList/index.ts diff --git a/packages/insights/RuleRetrieve/index.ts b/packages/insights/src/RuleRetrieve/index.ts similarity index 100% rename from packages/insights/RuleRetrieve/index.ts rename to packages/insights/src/RuleRetrieve/index.ts diff --git a/packages/insights/RuleStatsRetrieve/index.ts b/packages/insights/src/RuleStatsRetrieve/index.ts similarity index 100% rename from packages/insights/RuleStatsRetrieve/index.ts rename to packages/insights/src/RuleStatsRetrieve/index.ts diff --git a/packages/insights/RuleSystemsDetailList/index.ts b/packages/insights/src/RuleSystemsDetailList/index.ts similarity index 88% rename from packages/insights/RuleSystemsDetailList/index.ts rename to packages/insights/src/RuleSystemsDetailList/index.ts index bcb6a9dc0..99673966d 100644 --- a/packages/insights/RuleSystemsDetailList/index.ts +++ b/packages/insights/src/RuleSystemsDetailList/index.ts @@ -79,6 +79,12 @@ export type RuleSystemsDetailListParams = { */ sort?: RuleSystemsDetailListSortEnum, /** + * Display only systems with this type (\'all\' = both types) + * @type { RuleSystemsDetailListSystemTypeEnum } + * @memberof RuleSystemsDetailListApi + */ + systemType?: RuleSystemsDetailListSystemTypeEnum, + /** * Tags have a namespace, key and value in the form namespace/key=value * @type { Array } * @memberof RuleSystemsDetailListApi @@ -165,6 +171,17 @@ export const RuleSystemsDetailListSortEnum = { RhelVersion: 'rhel_version' } as const; export type RuleSystemsDetailListSortEnum = typeof RuleSystemsDetailListSortEnum[keyof typeof RuleSystemsDetailListSortEnum]; +/** + * @export + * @enum {string} + */ +export const RuleSystemsDetailListSystemTypeEnum = { + All: 'all', + Bootc: 'bootc', + Conventional: 'conventional', + Edge: 'edge' +} as const; +export type RuleSystemsDetailListSystemTypeEnum = typeof RuleSystemsDetailListSystemTypeEnum[keyof typeof RuleSystemsDetailListSystemTypeEnum]; export type RuleSystemsDetailListReturnType = PaginatedSystemsDetailList; @@ -181,9 +198,9 @@ const isRuleSystemsDetailListObjectParams = (params: [RuleSystemsDetailListParam * @param {*} [options] Override http request option. * @throws {RequiredError} */ -export const ruleSystemsDetailListParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([RuleSystemsDetailListParams] | [string, boolean, boolean, Array, boolean, Array, number, string, number, Array, RuleSystemsDetailListSortEnum, Array, AxiosRequestConfig])) => { - const params = isRuleSystemsDetailListObjectParams(config) ? config[0] : ['ruleId', 'filterSystemProfileAnsible', 'filterSystemProfileMssql', 'filterSystemProfileSapSidsContains', 'filterSystemProfileSapSystem', 'groups', 'limit', 'name', 'offset', 'rhelVersion', 'sort', 'tags', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as RuleSystemsDetailListParams; - const { ruleId, filterSystemProfileAnsible, filterSystemProfileMssql, filterSystemProfileSapSidsContains, filterSystemProfileSapSystem, groups, limit, name, offset, rhelVersion, sort, tags, options = {} } = params; +export const ruleSystemsDetailListParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([RuleSystemsDetailListParams] | [string, boolean, boolean, Array, boolean, Array, number, string, number, Array, RuleSystemsDetailListSortEnum, RuleSystemsDetailListSystemTypeEnum, Array, AxiosRequestConfig])) => { + const params = isRuleSystemsDetailListObjectParams(config) ? config[0] : ['ruleId', 'filterSystemProfileAnsible', 'filterSystemProfileMssql', 'filterSystemProfileSapSidsContains', 'filterSystemProfileSapSystem', 'groups', 'limit', 'name', 'offset', 'rhelVersion', 'sort', 'systemType', 'tags', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as RuleSystemsDetailListParams; + const { ruleId, filterSystemProfileAnsible, filterSystemProfileMssql, filterSystemProfileSapSidsContains, filterSystemProfileSapSystem, groups, limit, name, offset, rhelVersion, sort, systemType, tags, options = {} } = params; const localVarPath = `/api/insights/v1/rule/{rule_id}/systems_detail/` .replace(`{${"rule_id"}}`, encodeURIComponent(String(ruleId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. @@ -232,6 +249,10 @@ export const ruleSystemsDetailListParamCreator = async (sendRequest: BaseAPI["se localVarQueryParameter['sort'] = sort; } + if (systemType !== undefined) { + localVarQueryParameter['system_type'] = systemType; + } + if (tags) { localVarQueryParameter['tags'] = tags; } diff --git a/packages/insights/RuleSystemsRetrieve/index.ts b/packages/insights/src/RuleSystemsRetrieve/index.ts similarity index 88% rename from packages/insights/RuleSystemsRetrieve/index.ts rename to packages/insights/src/RuleSystemsRetrieve/index.ts index 1adf63c30..a4108379f 100644 --- a/packages/insights/RuleSystemsRetrieve/index.ts +++ b/packages/insights/src/RuleSystemsRetrieve/index.ts @@ -73,6 +73,12 @@ export type RuleSystemsRetrieveParams = { */ sort?: Array, /** + * Display only systems with this type (\'all\' = both types) + * @type { RuleSystemsRetrieveSystemTypeEnum } + * @memberof RuleSystemsRetrieveApi + */ + systemType?: RuleSystemsRetrieveSystemTypeEnum, + /** * Tags have a namespace, key and value in the form namespace/key=value * @type { Array } * @memberof RuleSystemsRetrieveApi @@ -164,6 +170,17 @@ export const RuleSystemsRetrieveSortEnum = { Updated: 'updated' } as const; export type RuleSystemsRetrieveSortEnum = typeof RuleSystemsRetrieveSortEnum[keyof typeof RuleSystemsRetrieveSortEnum]; +/** + * @export + * @enum {string} + */ +export const RuleSystemsRetrieveSystemTypeEnum = { + All: 'all', + Bootc: 'bootc', + Conventional: 'conventional', + Edge: 'edge' +} as const; +export type RuleSystemsRetrieveSystemTypeEnum = typeof RuleSystemsRetrieveSystemTypeEnum[keyof typeof RuleSystemsRetrieveSystemTypeEnum]; /** * @export * @enum {string} @@ -189,9 +206,9 @@ const isRuleSystemsRetrieveObjectParams = (params: [RuleSystemsRetrieveParams] | * @param {*} [options] Override http request option. * @throws {RequiredError} */ -export const ruleSystemsRetrieveParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([RuleSystemsRetrieveParams] | [string, boolean, boolean, Array, boolean, RuleSystemsRetrieveFormatEnum, Array, string, Array, Array, Array, Array, AxiosRequestConfig])) => { - const params = isRuleSystemsRetrieveObjectParams(config) ? config[0] : ['ruleId', 'filterSystemProfileAnsible', 'filterSystemProfileMssql', 'filterSystemProfileSapSidsContains', 'filterSystemProfileSapSystem', 'format', 'groups', 'name', 'rhelVersion', 'sort', 'tags', 'updateMethod', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as RuleSystemsRetrieveParams; - const { ruleId, filterSystemProfileAnsible, filterSystemProfileMssql, filterSystemProfileSapSidsContains, filterSystemProfileSapSystem, format, groups, name, rhelVersion, sort, tags, updateMethod, options = {} } = params; +export const ruleSystemsRetrieveParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([RuleSystemsRetrieveParams] | [string, boolean, boolean, Array, boolean, RuleSystemsRetrieveFormatEnum, Array, string, Array, Array, RuleSystemsRetrieveSystemTypeEnum, Array, Array, AxiosRequestConfig])) => { + const params = isRuleSystemsRetrieveObjectParams(config) ? config[0] : ['ruleId', 'filterSystemProfileAnsible', 'filterSystemProfileMssql', 'filterSystemProfileSapSidsContains', 'filterSystemProfileSapSystem', 'format', 'groups', 'name', 'rhelVersion', 'sort', 'systemType', 'tags', 'updateMethod', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as RuleSystemsRetrieveParams; + const { ruleId, filterSystemProfileAnsible, filterSystemProfileMssql, filterSystemProfileSapSidsContains, filterSystemProfileSapSystem, format, groups, name, rhelVersion, sort, systemType, tags, updateMethod, options = {} } = params; const localVarPath = `/api/insights/v1/rule/{rule_id}/systems/` .replace(`{${"rule_id"}}`, encodeURIComponent(String(ruleId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. @@ -236,6 +253,10 @@ export const ruleSystemsRetrieveParamCreator = async (sendRequest: BaseAPI["send localVarQueryParameter['sort'] = sort; } + if (systemType !== undefined) { + localVarQueryParameter['system_type'] = systemType; + } + if (tags) { localVarQueryParameter['tags'] = tags; } diff --git a/packages/insights/RuleUnackHostsCreate/index.ts b/packages/insights/src/RuleUnackHostsCreate/index.ts similarity index 100% rename from packages/insights/RuleUnackHostsCreate/index.ts rename to packages/insights/src/RuleUnackHostsCreate/index.ts diff --git a/packages/insights/RulecategoryList/index.ts b/packages/insights/src/RulecategoryList/index.ts similarity index 100% rename from packages/insights/RulecategoryList/index.ts rename to packages/insights/src/RulecategoryList/index.ts diff --git a/packages/insights/RulecategoryRetrieve/index.ts b/packages/insights/src/RulecategoryRetrieve/index.ts similarity index 100% rename from packages/insights/RulecategoryRetrieve/index.ts rename to packages/insights/src/RulecategoryRetrieve/index.ts diff --git a/packages/insights/StatsList/index.ts b/packages/insights/src/StatsList/index.ts similarity index 100% rename from packages/insights/StatsList/index.ts rename to packages/insights/src/StatsList/index.ts diff --git a/packages/insights/StatsOverviewRetrieve/index.ts b/packages/insights/src/StatsOverviewRetrieve/index.ts similarity index 100% rename from packages/insights/StatsOverviewRetrieve/index.ts rename to packages/insights/src/StatsOverviewRetrieve/index.ts diff --git a/packages/insights/StatsReportsRetrieve/index.ts b/packages/insights/src/StatsReportsRetrieve/index.ts similarity index 100% rename from packages/insights/StatsReportsRetrieve/index.ts rename to packages/insights/src/StatsReportsRetrieve/index.ts diff --git a/packages/insights/StatsRulesRetrieve/index.ts b/packages/insights/src/StatsRulesRetrieve/index.ts similarity index 100% rename from packages/insights/StatsRulesRetrieve/index.ts rename to packages/insights/src/StatsRulesRetrieve/index.ts diff --git a/packages/insights/StatsSystemsRetrieve/index.ts b/packages/insights/src/StatsSystemsRetrieve/index.ts similarity index 100% rename from packages/insights/StatsSystemsRetrieve/index.ts rename to packages/insights/src/StatsSystemsRetrieve/index.ts diff --git a/packages/insights/StatusLiveRetrieve/index.ts b/packages/insights/src/StatusLiveRetrieve/index.ts similarity index 100% rename from packages/insights/StatusLiveRetrieve/index.ts rename to packages/insights/src/StatusLiveRetrieve/index.ts diff --git a/packages/insights/StatusReadyRetrieve/index.ts b/packages/insights/src/StatusReadyRetrieve/index.ts similarity index 100% rename from packages/insights/StatusReadyRetrieve/index.ts rename to packages/insights/src/StatusReadyRetrieve/index.ts diff --git a/packages/insights/StatusRetrieve/index.ts b/packages/insights/src/StatusRetrieve/index.ts similarity index 100% rename from packages/insights/StatusRetrieve/index.ts rename to packages/insights/src/StatusRetrieve/index.ts diff --git a/packages/insights/SystemList/index.ts b/packages/insights/src/SystemList/index.ts similarity index 90% rename from packages/insights/SystemList/index.ts rename to packages/insights/src/SystemList/index.ts index 584afab21..aa97e815e 100644 --- a/packages/insights/SystemList/index.ts +++ b/packages/insights/src/SystemList/index.ts @@ -97,6 +97,12 @@ export type SystemListParams = { */ sort?: SystemListSortEnum, /** + * Display only systems with this type (\'all\' = both types) + * @type { SystemListSystemTypeEnum } + * @memberof SystemListApi + */ + systemType?: SystemListSystemTypeEnum, + /** * Tags have a namespace, key and value in the form namespace/key=value * @type { Array } * @memberof SystemListApi @@ -201,6 +207,17 @@ export const SystemListSortEnum = { RhelVersion: 'rhel_version' } as const; export type SystemListSortEnum = typeof SystemListSortEnum[keyof typeof SystemListSortEnum]; +/** + * @export + * @enum {string} + */ +export const SystemListSystemTypeEnum = { + All: 'all', + Bootc: 'bootc', + Conventional: 'conventional', + Edge: 'edge' +} as const; +export type SystemListSystemTypeEnum = typeof SystemListSystemTypeEnum[keyof typeof SystemListSystemTypeEnum]; /** * @export * @enum {string} @@ -226,9 +243,9 @@ const isSystemListObjectParams = (params: [SystemListParams] | unknown[]): param * @param {*} [options] Override http request option. * @throws {RequiredError} */ -export const systemListParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([SystemListParams] | [string, boolean, boolean, Array, boolean, Array, boolean, Array, boolean, number, number, string, Array, SystemListSortEnum, Array, Array, AxiosRequestConfig])) => { - const params = isSystemListObjectParams(config) ? config[0] : ['displayName', 'filterSystemProfileAnsible', 'filterSystemProfileMssql', 'filterSystemProfileSapSidsContains', 'filterSystemProfileSapSystem', 'groups', 'hasDisabledRecommendation', 'hits', 'incident', 'limit', 'offset', 'pathway', 'rhelVersion', 'sort', 'tags', 'updateMethod', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as SystemListParams; - const { displayName, filterSystemProfileAnsible, filterSystemProfileMssql, filterSystemProfileSapSidsContains, filterSystemProfileSapSystem, groups, hasDisabledRecommendation, hits, incident, limit, offset, pathway, rhelVersion, sort, tags, updateMethod, options = {} } = params; +export const systemListParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([SystemListParams] | [string, boolean, boolean, Array, boolean, Array, boolean, Array, boolean, number, number, string, Array, SystemListSortEnum, SystemListSystemTypeEnum, Array, Array, AxiosRequestConfig])) => { + const params = isSystemListObjectParams(config) ? config[0] : ['displayName', 'filterSystemProfileAnsible', 'filterSystemProfileMssql', 'filterSystemProfileSapSidsContains', 'filterSystemProfileSapSystem', 'groups', 'hasDisabledRecommendation', 'hits', 'incident', 'limit', 'offset', 'pathway', 'rhelVersion', 'sort', 'systemType', 'tags', 'updateMethod', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as SystemListParams; + const { displayName, filterSystemProfileAnsible, filterSystemProfileMssql, filterSystemProfileSapSidsContains, filterSystemProfileSapSystem, groups, hasDisabledRecommendation, hits, incident, limit, offset, pathway, rhelVersion, sort, systemType, tags, updateMethod, options = {} } = params; const localVarPath = `/api/insights/v1/system/`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -292,6 +309,10 @@ export const systemListParamCreator = async (sendRequest: BaseAPI["sendRequest"] localVarQueryParameter['sort'] = sort; } + if (systemType !== undefined) { + localVarQueryParameter['system_type'] = systemType; + } + if (tags) { localVarQueryParameter['tags'] = tags; } diff --git a/packages/insights/SystemReportsList/index.ts b/packages/insights/src/SystemReportsList/index.ts similarity index 84% rename from packages/insights/SystemReportsList/index.ts rename to packages/insights/src/SystemReportsList/index.ts index 35d488d80..749c71c49 100644 --- a/packages/insights/SystemReportsList/index.ts +++ b/packages/insights/src/SystemReportsList/index.ts @@ -49,6 +49,12 @@ export type SystemReportsListParams = { */ groups?: Array, /** + * Display only systems with this type (\'all\' = both types) + * @type { SystemReportsListSystemTypeEnum } + * @memberof SystemReportsListApi + */ + systemType?: SystemReportsListSystemTypeEnum, + /** * Tags have a namespace, key and value in the form namespace/key=value * @type { Array } * @memberof SystemReportsListApi @@ -62,6 +68,17 @@ export type SystemReportsListParams = { updateMethod?: Array, options?: AxiosRequestConfig } +/** + * @export + * @enum {string} + */ +export const SystemReportsListSystemTypeEnum = { + All: 'all', + Bootc: 'bootc', + Conventional: 'conventional', + Edge: 'edge' +} as const; +export type SystemReportsListSystemTypeEnum = typeof SystemReportsListSystemTypeEnum[keyof typeof SystemReportsListSystemTypeEnum]; /** * @export * @enum {string} @@ -87,9 +104,9 @@ const isSystemReportsListObjectParams = (params: [SystemReportsListParams] | unk * @param {*} [options] Override http request option. * @throws {RequiredError} */ -export const systemReportsListParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([SystemReportsListParams] | [string, boolean, boolean, Array, boolean, Array, Array, Array, AxiosRequestConfig])) => { - const params = isSystemReportsListObjectParams(config) ? config[0] : ['uuid', 'filterSystemProfileAnsible', 'filterSystemProfileMssql', 'filterSystemProfileSapSidsContains', 'filterSystemProfileSapSystem', 'groups', 'tags', 'updateMethod', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as SystemReportsListParams; - const { uuid, filterSystemProfileAnsible, filterSystemProfileMssql, filterSystemProfileSapSidsContains, filterSystemProfileSapSystem, groups, tags, updateMethod, options = {} } = params; +export const systemReportsListParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([SystemReportsListParams] | [string, boolean, boolean, Array, boolean, Array, SystemReportsListSystemTypeEnum, Array, Array, AxiosRequestConfig])) => { + const params = isSystemReportsListObjectParams(config) ? config[0] : ['uuid', 'filterSystemProfileAnsible', 'filterSystemProfileMssql', 'filterSystemProfileSapSidsContains', 'filterSystemProfileSapSystem', 'groups', 'systemType', 'tags', 'updateMethod', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as SystemReportsListParams; + const { uuid, filterSystemProfileAnsible, filterSystemProfileMssql, filterSystemProfileSapSidsContains, filterSystemProfileSapSystem, groups, systemType, tags, updateMethod, options = {} } = params; const localVarPath = `/api/insights/v1/system/{uuid}/reports/` .replace(`{${"uuid"}}`, encodeURIComponent(String(uuid))); // use dummy base URL string because the URL constructor only accepts absolute URLs. @@ -118,6 +135,10 @@ export const systemReportsListParamCreator = async (sendRequest: BaseAPI["sendRe localVarQueryParameter['groups'] = groups; } + if (systemType !== undefined) { + localVarQueryParameter['system_type'] = systemType; + } + if (tags) { localVarQueryParameter['tags'] = tags; } diff --git a/packages/insights/SystemRetrieve/index.ts b/packages/insights/src/SystemRetrieve/index.ts similarity index 100% rename from packages/insights/SystemRetrieve/index.ts rename to packages/insights/src/SystemRetrieve/index.ts diff --git a/packages/insights/SystemtypeList/index.ts b/packages/insights/src/SystemtypeList/index.ts similarity index 100% rename from packages/insights/SystemtypeList/index.ts rename to packages/insights/src/SystemtypeList/index.ts diff --git a/packages/insights/SystemtypeRetrieve/index.ts b/packages/insights/src/SystemtypeRetrieve/index.ts similarity index 100% rename from packages/insights/SystemtypeRetrieve/index.ts rename to packages/insights/src/SystemtypeRetrieve/index.ts diff --git a/packages/insights/TopicList/index.ts b/packages/insights/src/TopicList/index.ts similarity index 100% rename from packages/insights/TopicList/index.ts rename to packages/insights/src/TopicList/index.ts diff --git a/packages/insights/TopicRetrieve/index.ts b/packages/insights/src/TopicRetrieve/index.ts similarity index 100% rename from packages/insights/TopicRetrieve/index.ts rename to packages/insights/src/TopicRetrieve/index.ts diff --git a/packages/insights/TopicRulesWithTagList/index.ts b/packages/insights/src/TopicRulesWithTagList/index.ts similarity index 100% rename from packages/insights/TopicRulesWithTagList/index.ts rename to packages/insights/src/TopicRulesWithTagList/index.ts diff --git a/packages/insights/TopicSystemsRetrieve/index.ts b/packages/insights/src/TopicSystemsRetrieve/index.ts similarity index 100% rename from packages/insights/TopicSystemsRetrieve/index.ts rename to packages/insights/src/TopicSystemsRetrieve/index.ts diff --git a/packages/insights/UserPreferencesCreate/index.ts b/packages/insights/src/UserPreferencesCreate/index.ts similarity index 100% rename from packages/insights/UserPreferencesCreate/index.ts rename to packages/insights/src/UserPreferencesCreate/index.ts diff --git a/packages/insights/UserPreferencesList/index.ts b/packages/insights/src/UserPreferencesList/index.ts similarity index 100% rename from packages/insights/UserPreferencesList/index.ts rename to packages/insights/src/UserPreferencesList/index.ts diff --git a/packages/insights/WeeklyreportautosubscribeCreate/index.ts b/packages/insights/src/WeeklyreportautosubscribeCreate/index.ts similarity index 100% rename from packages/insights/WeeklyreportautosubscribeCreate/index.ts rename to packages/insights/src/WeeklyreportautosubscribeCreate/index.ts diff --git a/packages/insights/WeeklyreportautosubscribeList/index.ts b/packages/insights/src/WeeklyreportautosubscribeList/index.ts similarity index 100% rename from packages/insights/WeeklyreportautosubscribeList/index.ts rename to packages/insights/src/WeeklyreportautosubscribeList/index.ts diff --git a/packages/insights/WeeklyreportsubscriptionCreate/index.ts b/packages/insights/src/WeeklyreportsubscriptionCreate/index.ts similarity index 100% rename from packages/insights/WeeklyreportsubscriptionCreate/index.ts rename to packages/insights/src/WeeklyreportsubscriptionCreate/index.ts diff --git a/packages/insights/WeeklyreportsubscriptionList/index.ts b/packages/insights/src/WeeklyreportsubscriptionList/index.ts similarity index 100% rename from packages/insights/WeeklyreportsubscriptionList/index.ts rename to packages/insights/src/WeeklyreportsubscriptionList/index.ts diff --git a/packages/insights/api.ts b/packages/insights/src/api.ts similarity index 94% rename from packages/insights/api.ts rename to packages/insights/src/api.ts index 28fe88d53..783df79d6 100644 --- a/packages/insights/api.ts +++ b/packages/insights/src/api.ts @@ -48,7 +48,6 @@ import { ruleUnackHostsCreate, rulecategoryList, rulecategoryRetrieve, - settingsList, statsList, statsOverviewRetrieve, statsReportsRetrieve, @@ -62,14 +61,10 @@ import { systemRetrieve, systemtypeList, systemtypeRetrieve, - topicCreate, - topicDestroy, topicList, - topicPartialUpdate, topicRetrieve, topicRulesWithTagList, topicSystemsRetrieve, - topicUpdate, userPreferencesCreate, userPreferencesList, weeklyreportautosubscribeCreate, @@ -125,7 +120,6 @@ const endpointList = { ruleUnackHostsCreate, rulecategoryList, rulecategoryRetrieve, - settingsList, statsList, statsOverviewRetrieve, statsReportsRetrieve, @@ -139,14 +133,10 @@ const endpointList = { systemRetrieve, systemtypeList, systemtypeRetrieve, - topicCreate, - topicDestroy, topicList, - topicPartialUpdate, topicRetrieve, topicRulesWithTagList, topicSystemsRetrieve, - topicUpdate, userPreferencesCreate, userPreferencesList, weeklyreportautosubscribeCreate, diff --git a/packages/insights/index.ts b/packages/insights/src/index.ts similarity index 93% rename from packages/insights/index.ts rename to packages/insights/src/index.ts index 2a88aa293..0fb30a2b4 100644 --- a/packages/insights/index.ts +++ b/packages/insights/src/index.ts @@ -88,8 +88,6 @@ export { default as rulecategoryList, type RulecategoryListReturnType } from './ export { default as rulecategoryRetrieve, type RulecategoryRetrieveReturnType } from './RulecategoryRetrieve' -export { default as settingsList, type SettingsListReturnType } from './SettingsList' - export { default as statsList, type StatsListReturnType } from './StatsList' export { default as statsOverviewRetrieve, type StatsOverviewRetrieveReturnType } from './StatsOverviewRetrieve' @@ -116,22 +114,14 @@ export { default as systemtypeList, type SystemtypeListReturnType } from './Syst export { default as systemtypeRetrieve, type SystemtypeRetrieveReturnType } from './SystemtypeRetrieve' -export { default as topicCreate, type TopicCreateReturnType } from './TopicCreate' - -export { default as topicDestroy, type TopicDestroyReturnType } from './TopicDestroy' - export { default as topicList, type TopicListReturnType } from './TopicList' -export { default as topicPartialUpdate, type TopicPartialUpdateReturnType } from './TopicPartialUpdate' - export { default as topicRetrieve, type TopicRetrieveReturnType } from './TopicRetrieve' export { default as topicRulesWithTagList, type TopicRulesWithTagListReturnType } from './TopicRulesWithTagList' export { default as topicSystemsRetrieve, type TopicSystemsRetrieveReturnType } from './TopicSystemsRetrieve' -export { default as topicUpdate, type TopicUpdateReturnType } from './TopicUpdate' - export { default as userPreferencesCreate, type UserPreferencesCreateReturnType } from './UserPreferencesCreate' export { default as userPreferencesList, type UserPreferencesListReturnType } from './UserPreferencesList' @@ -146,5 +136,3 @@ export { default as weeklyreportsubscriptionList, type WeeklyreportsubscriptionL export * from './types' - -// Trigger release - updated to regenerate clients diff --git a/packages/insights/types/index.ts b/packages/insights/src/types/index.ts similarity index 89% rename from packages/insights/types/index.ts rename to packages/insights/src/types/index.ts index db6e182b7..c3f4c290b 100644 --- a/packages/insights/types/index.ts +++ b/packages/insights/src/types/index.ts @@ -514,97 +514,72 @@ export interface MultiHostUnAck { /** * * @export - * @interface PaginatedAckCountList + * @interface PaginatedAckList */ -export interface PaginatedAckCountList { +export interface PaginatedAckList { /** * - * @type {PaginatedAckCountListMeta} - * @memberof PaginatedAckCountList + * @type {PaginatedAckListMeta} + * @memberof PaginatedAckList */ - 'meta'?: PaginatedAckCountListMeta; + 'meta'?: PaginatedAckListMeta; /** * - * @type {PaginatedAckCountListLinks} - * @memberof PaginatedAckCountList + * @type {PaginatedAckListLinks} + * @memberof PaginatedAckList */ - 'links'?: PaginatedAckCountListLinks; + 'links'?: PaginatedAckListLinks; /** * - * @type {Array} - * @memberof PaginatedAckCountList + * @type {Array} + * @memberof PaginatedAckList */ - 'data'?: Array; + 'data'?: Array; } /** * * @export - * @interface PaginatedAckCountListLinks + * @interface PaginatedAckListLinks */ -export interface PaginatedAckCountListLinks { +export interface PaginatedAckListLinks { /** * * @type {string} - * @memberof PaginatedAckCountListLinks + * @memberof PaginatedAckListLinks */ 'first'?: string | null; /** * * @type {string} - * @memberof PaginatedAckCountListLinks + * @memberof PaginatedAckListLinks */ 'previous'?: string | null; /** * * @type {string} - * @memberof PaginatedAckCountListLinks + * @memberof PaginatedAckListLinks */ 'next'?: string | null; /** * * @type {string} - * @memberof PaginatedAckCountListLinks + * @memberof PaginatedAckListLinks */ 'last'?: string | null; } /** * * @export - * @interface PaginatedAckCountListMeta + * @interface PaginatedAckListMeta */ -export interface PaginatedAckCountListMeta { +export interface PaginatedAckListMeta { /** * * @type {number} - * @memberof PaginatedAckCountListMeta + * @memberof PaginatedAckListMeta */ 'count': number; } -/** - * - * @export - * @interface PaginatedAckList - */ -export interface PaginatedAckList { - /** - * - * @type {PaginatedAckCountListMeta} - * @memberof PaginatedAckList - */ - 'meta'?: PaginatedAckCountListMeta; - /** - * - * @type {PaginatedAckCountListLinks} - * @memberof PaginatedAckList - */ - 'links'?: PaginatedAckCountListLinks; - /** - * - * @type {Array} - * @memberof PaginatedAckList - */ - 'data'?: Array; -} /** * * @export @@ -613,16 +588,16 @@ export interface PaginatedAckList { export interface PaginatedAllRuleRatingsList { /** * - * @type {PaginatedAckCountListMeta} + * @type {PaginatedAckListMeta} * @memberof PaginatedAllRuleRatingsList */ - 'meta'?: PaginatedAckCountListMeta; + 'meta'?: PaginatedAckListMeta; /** * - * @type {PaginatedAckCountListLinks} + * @type {PaginatedAckListLinks} * @memberof PaginatedAllRuleRatingsList */ - 'links'?: PaginatedAckCountListLinks; + 'links'?: PaginatedAckListLinks; /** * * @type {Array} @@ -638,16 +613,16 @@ export interface PaginatedAllRuleRatingsList { export interface PaginatedDisabledRulesList { /** * - * @type {PaginatedAckCountListMeta} + * @type {PaginatedAckListMeta} * @memberof PaginatedDisabledRulesList */ - 'meta'?: PaginatedAckCountListMeta; + 'meta'?: PaginatedAckListMeta; /** * - * @type {PaginatedAckCountListLinks} + * @type {PaginatedAckListLinks} * @memberof PaginatedDisabledRulesList */ - 'links'?: PaginatedAckCountListLinks; + 'links'?: PaginatedAckListLinks; /** * * @type {Array} @@ -663,16 +638,16 @@ export interface PaginatedDisabledRulesList { export interface PaginatedHostAckList { /** * - * @type {PaginatedAckCountListMeta} + * @type {PaginatedAckListMeta} * @memberof PaginatedHostAckList */ - 'meta'?: PaginatedAckCountListMeta; + 'meta'?: PaginatedAckListMeta; /** * - * @type {PaginatedAckCountListLinks} + * @type {PaginatedAckListLinks} * @memberof PaginatedHostAckList */ - 'links'?: PaginatedAckCountListLinks; + 'links'?: PaginatedAckListLinks; /** * * @type {Array} @@ -688,16 +663,16 @@ export interface PaginatedHostAckList { export interface PaginatedJustificationCountList { /** * - * @type {PaginatedAckCountListMeta} + * @type {PaginatedAckListMeta} * @memberof PaginatedJustificationCountList */ - 'meta'?: PaginatedAckCountListMeta; + 'meta'?: PaginatedAckListMeta; /** * - * @type {PaginatedAckCountListLinks} + * @type {PaginatedAckListLinks} * @memberof PaginatedJustificationCountList */ - 'links'?: PaginatedAckCountListLinks; + 'links'?: PaginatedAckListLinks; /** * * @type {Array} @@ -713,16 +688,16 @@ export interface PaginatedJustificationCountList { export interface PaginatedPathwayList { /** * - * @type {PaginatedAckCountListMeta} + * @type {PaginatedAckListMeta} * @memberof PaginatedPathwayList */ - 'meta'?: PaginatedAckCountListMeta; + 'meta'?: PaginatedAckListMeta; /** * - * @type {PaginatedAckCountListLinks} + * @type {PaginatedAckListLinks} * @memberof PaginatedPathwayList */ - 'links'?: PaginatedAckCountListLinks; + 'links'?: PaginatedAckListLinks; /** * * @type {Array} @@ -738,16 +713,16 @@ export interface PaginatedPathwayList { export interface PaginatedRuleForAccountList { /** * - * @type {PaginatedAckCountListMeta} + * @type {PaginatedAckListMeta} * @memberof PaginatedRuleForAccountList */ - 'meta'?: PaginatedAckCountListMeta; + 'meta'?: PaginatedAckListMeta; /** * - * @type {PaginatedAckCountListLinks} + * @type {PaginatedAckListLinks} * @memberof PaginatedRuleForAccountList */ - 'links'?: PaginatedAckCountListLinks; + 'links'?: PaginatedAckListLinks; /** * * @type {Array} @@ -763,16 +738,16 @@ export interface PaginatedRuleForAccountList { export interface PaginatedRuleRatingList { /** * - * @type {PaginatedAckCountListMeta} + * @type {PaginatedAckListMeta} * @memberof PaginatedRuleRatingList */ - 'meta'?: PaginatedAckCountListMeta; + 'meta'?: PaginatedAckListMeta; /** * - * @type {PaginatedAckCountListLinks} + * @type {PaginatedAckListLinks} * @memberof PaginatedRuleRatingList */ - 'links'?: PaginatedAckCountListLinks; + 'links'?: PaginatedAckListLinks; /** * * @type {Array} @@ -788,16 +763,16 @@ export interface PaginatedRuleRatingList { export interface PaginatedRuleRatingStatsList { /** * - * @type {PaginatedAckCountListMeta} + * @type {PaginatedAckListMeta} * @memberof PaginatedRuleRatingStatsList */ - 'meta'?: PaginatedAckCountListMeta; + 'meta'?: PaginatedAckListMeta; /** * - * @type {PaginatedAckCountListLinks} + * @type {PaginatedAckListLinks} * @memberof PaginatedRuleRatingStatsList */ - 'links'?: PaginatedAckCountListLinks; + 'links'?: PaginatedAckListLinks; /** * * @type {Array} @@ -813,16 +788,16 @@ export interface PaginatedRuleRatingStatsList { export interface PaginatedSubscriptionExcludedAccountList { /** * - * @type {PaginatedAckCountListMeta} + * @type {PaginatedAckListMeta} * @memberof PaginatedSubscriptionExcludedAccountList */ - 'meta'?: PaginatedAckCountListMeta; + 'meta'?: PaginatedAckListMeta; /** * - * @type {PaginatedAckCountListLinks} + * @type {PaginatedAckListLinks} * @memberof PaginatedSubscriptionExcludedAccountList */ - 'links'?: PaginatedAckCountListLinks; + 'links'?: PaginatedAckListLinks; /** * * @type {Array} @@ -838,16 +813,16 @@ export interface PaginatedSubscriptionExcludedAccountList { export interface PaginatedSystemList { /** * - * @type {PaginatedAckCountListMeta} + * @type {PaginatedAckListMeta} * @memberof PaginatedSystemList */ - 'meta'?: PaginatedAckCountListMeta; + 'meta'?: PaginatedAckListMeta; /** * - * @type {PaginatedAckCountListLinks} + * @type {PaginatedAckListLinks} * @memberof PaginatedSystemList */ - 'links'?: PaginatedAckCountListLinks; + 'links'?: PaginatedAckListLinks; /** * * @type {Array} @@ -863,16 +838,16 @@ export interface PaginatedSystemList { export interface PaginatedSystemsDetailList { /** * - * @type {PaginatedAckCountListMeta} + * @type {PaginatedAckListMeta} * @memberof PaginatedSystemsDetailList */ - 'meta'?: PaginatedAckCountListMeta; + 'meta'?: PaginatedAckListMeta; /** * - * @type {PaginatedAckCountListLinks} + * @type {PaginatedAckListLinks} * @memberof PaginatedSystemsDetailList */ - 'links'?: PaginatedAckCountListLinks; + 'links'?: PaginatedAckListLinks; /** * * @type {Array} @@ -880,49 +855,6 @@ export interface PaginatedSystemsDetailList { */ 'data'?: Array; } -/** - * Create or edit topics. - * @export - * @interface PatchedTopicEdit - */ -export interface PatchedTopicEdit { - /** - * - * @type {string} - * @memberof PatchedTopicEdit - */ - 'name'?: string; - /** - * Rule topic slug - * @type {string} - * @memberof PatchedTopicEdit - */ - 'slug'?: string; - /** - * - * @type {string} - * @memberof PatchedTopicEdit - */ - 'description'?: string; - /** - * - * @type {string} - * @memberof PatchedTopicEdit - */ - 'tag'?: string; - /** - * - * @type {boolean} - * @memberof PatchedTopicEdit - */ - 'featured'?: boolean; - /** - * - * @type {boolean} - * @memberof PatchedTopicEdit - */ - 'enabled'?: boolean; -} /** * Serializer specifically for listing all Pathways currently in the system * @export @@ -1984,6 +1916,12 @@ export interface System { * @memberof System */ 'pathway_filter_hits': number; + /** + * + * @type {string} + * @memberof System + */ + 'os_name': string; /** * * @type {string} @@ -2100,6 +2038,12 @@ export interface SystemsDetail { * @memberof SystemsDetail */ 'pathway_filter_hits': number; + /** + * + * @type {string} + * @memberof SystemsDetail + */ + 'os_name': string; /** * * @type {string} @@ -2175,49 +2119,6 @@ export interface Topic { */ 'impacted_systems_count': number; } -/** - * Create or edit topics. - * @export - * @interface TopicEdit - */ -export interface TopicEdit { - /** - * - * @type {string} - * @memberof TopicEdit - */ - 'name': string; - /** - * Rule topic slug - * @type {string} - * @memberof TopicEdit - */ - 'slug': string; - /** - * - * @type {string} - * @memberof TopicEdit - */ - 'description': string; - /** - * - * @type {string} - * @memberof TopicEdit - */ - 'tag': string; - /** - * - * @type {boolean} - * @memberof TopicEdit - */ - 'featured'?: boolean; - /** - * - * @type {boolean} - * @memberof TopicEdit - */ - 'enabled'?: boolean; -} /** * * @export diff --git a/packages/insights/tsconfig.cjs.json b/packages/insights/tsconfig.cjs.json index d29a1ef4a..34a67d692 100644 --- a/packages/insights/tsconfig.cjs.json +++ b/packages/insights/tsconfig.cjs.json @@ -1,6 +1,21 @@ { "extends": "./tsconfig.esm.json", "compilerOptions": { - "module": "CommonJS", + "declaration": true, + "target": "es5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": ".", + "rootDir": ".", + "lib": [ + "es2017", + "dom" + ] }, + "exclude": [ + "dist", + "node_modules", + "*.d.ts", + "jest.config.ts" + ] } diff --git a/packages/insights/tsconfig.esm.json b/packages/insights/tsconfig.esm.json index 28ffe1d28..030c3c5d1 100644 --- a/packages/insights/tsconfig.esm.json +++ b/packages/insights/tsconfig.esm.json @@ -1,13 +1,23 @@ { "extends": "./tsconfig.json", "compilerOptions": { - "outDir": "../../dist/out-tsc", + "target": "es2021", + "module": "esnext", + "moduleResolution": "node", "declaration": true, - "types": ["node"], - "module": "ES2015", - "target": "ES5", - "rootDir": "./", + "declarationMap": true, + "noImplicitAny": true, + "outDir": "esm", + "lib": [ + "es2017", + "dom" + ] }, - "include": ["*.ts", "**/*.ts"], - "exclude": ["jest.config.ts", "dist"] + "include": ["src/**/*.ts"], + "exclude": [ + "dist", + "node_modules", + "*.d.ts", + "jest.config.ts" + ] } diff --git a/tsconfig.base.json b/tsconfig.base.json index 69d779042..b311b54f7 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -20,7 +20,7 @@ "@redhat-cloud-services/config-manager-client": ["packages/config-manager/index.ts"], "@redhat-cloud-services/entitlements-client": ["packages/entitlements/index.ts"], "@redhat-cloud-services/host-inventory-client": ["packages/host-inventory/index.ts"], - "@redhat-cloud-services/insights-client": ["packages/insights/index.ts"], + "@redhat-cloud-services/insights-client": ["packages/insights/src/index.ts"], "@redhat-cloud-services/integrations-client": ["packages/integrations/src/index.ts"], "@redhat-cloud-services/notifications-client": ["packages/notifications/index.ts"], "@redhat-cloud-services/patch-client": ["packages/patch/index.ts"],