diff --git a/packages/compliance/TailoringFile/index.ts b/packages/compliance/TailoringFile/index.ts deleted file mode 100644 index d1d2e1e54..000000000 --- a/packages/compliance/TailoringFile/index.ts +++ /dev/null @@ -1,77 +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 { TailoringFile } from '../types'; - - -export type TailoringFileParams = { - /** - * - * @type { any } - * @memberof TailoringFileApi - */ - policyId: any, - /** - * UUID or OS minor version number - * @type { any } - * @memberof TailoringFileApi - */ - tailoringId: any, - /** - * For internal use only - * @type { any } - * @memberof TailoringFileApi - */ - xRHIDENTITY?: any, - options?: AxiosRequestConfig -} - -export type TailoringFileReturnType = AxiosPromise; - -const isTailoringFileObjectParams = (params: [TailoringFileParams] | unknown[]): params is [TailoringFileParams] => { - return params.length === 1 && Object.prototype.hasOwnProperty.call(params, 'policyId') && Object.prototype.hasOwnProperty.call(params, 'tailoringId') && true -} -/** -* Returns a Tailoring File -* @summary Request a Tailoring file -* @param {TailoringFileParams} config with all available params. -* @param {*} [options] Override http request option. -* @throws {RequiredError} -*/ -export const tailoringFileParamCreator = async (...config: ([TailoringFileParams] | [any, any, any, AxiosRequestConfig])): Promise => { - const params = isTailoringFileObjectParams(config) ? config[0] : ['policyId', 'tailoringId', 'xRHIDENTITY', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as TailoringFileParams; - const { policyId, tailoringId, xRHIDENTITY, options = {} } = params; - const localVarPath = `/policies/{policy_id}/tailorings/{tailoring_id}/tailoring_file.json` - .replace(`{${"policy_id"}}`, encodeURIComponent(String(policyId))) - .replace(`{${"tailoring_id"}}`, encodeURIComponent(String(tailoringId))); - // 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 (xRHIDENTITY != null) { - localVarHeaderParameter['X-RH-IDENTITY'] = typeof xRHIDENTITY === 'string' - ? xRHIDENTITY - : JSON.stringify(xRHIDENTITY); - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; - - return { - urlObj: localVarUrlObj, - options: localVarRequestOptions, - }; -} - -export default tailoringFileParamCreator; diff --git a/packages/compliance/doc/.nojekyll b/packages/compliance/doc/.nojekyll deleted file mode 100644 index e2ac6616a..000000000 --- a/packages/compliance/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/compliance/doc/README.md b/packages/compliance/doc/README.md deleted file mode 100644 index 9a3411877..000000000 --- a/packages/compliance/doc/README.md +++ /dev/null @@ -1,69 +0,0 @@ -@redhat-cloud-services/compliance-client / [Exports](modules.md) - -# Javascript client for the compliance API -If you want to use [RedHatInsights/compliance](https://github.com/RedHatInsights/compliance) 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/compliance-client -``` - -Or Yarn -```bash -yarn add @redhat-cloud-services/compliance-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 { Configuration } from '@redhat-cloud-services/compliance-client'; -const instance = axios.create(); - -// BASE_PATH should be set in your constants file -const configApi = new Configuration(undefined, BASE_PATH, instance); -export configApi; -``` - -If you want to add some interceptors you can use axios build in interceptors -```JS -// api.js -import axios from 'axios'; -import { Configuration } from '@redhat-cloud-services/compliance-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 configApi = new Configuration(undefined, BASE_PATH, instance); -export configApi; -``` - -## Building - -Run `nx build @redhat-cloud-services/compliance-client` to build the library. - -## Running unit tests - -Run `nx test @redhat-cloud-services/compliance-client` to execute the unit tests via [Jest](https://jestjs.io). - -## API documentation - -* [README](doc/README.md) diff --git a/packages/compliance/doc/interfaces/AssignRulesRequest.md b/packages/compliance/doc/interfaces/AssignRulesRequest.md deleted file mode 100644 index 0f0c065a3..000000000 --- a/packages/compliance/doc/interfaces/AssignRulesRequest.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / AssignRulesRequest - -# Interface: AssignRulesRequest - -**`Export`** - -AssignRulesRequest - -## Table of contents - -### Properties - -- [ids](AssignRulesRequest.md#ids) - -## Properties - -### ids - -• `Optional` **ids**: `any` - -**`Memberof`** - -AssignRulesRequest - -#### Defined in - -[types/index.ts:12](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L12) diff --git a/packages/compliance/doc/interfaces/CreatePolicy201Response.md b/packages/compliance/doc/interfaces/CreatePolicy201Response.md deleted file mode 100644 index 82bf6ab99..000000000 --- a/packages/compliance/doc/interfaces/CreatePolicy201Response.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / CreatePolicy201Response - -# Interface: CreatePolicy201Response - -**`Export`** - -CreatePolicy201Response - -## Table of contents - -### Properties - -- [data](CreatePolicy201Response.md#data) - -## Properties - -### data - -• `Optional` **data**: [`CreatePolicy201ResponseData`](CreatePolicy201ResponseData.md) - -**`Memberof`** - -CreatePolicy201Response - -#### Defined in - -[types/index.ts:25](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L25) diff --git a/packages/compliance/doc/interfaces/CreatePolicy201ResponseData.md b/packages/compliance/doc/interfaces/CreatePolicy201ResponseData.md deleted file mode 100644 index 977f984c2..000000000 --- a/packages/compliance/doc/interfaces/CreatePolicy201ResponseData.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / CreatePolicy201ResponseData - -# Interface: CreatePolicy201ResponseData - -**`Export`** - -CreatePolicy201ResponseData - -## Table of contents - -### Properties - -- [schema](CreatePolicy201ResponseData.md#schema) - -## Properties - -### schema - -• `Optional` **schema**: [`Policy`](Policy.md) - -**`Memberof`** - -CreatePolicy201ResponseData - -#### Defined in - -[types/index.ts:38](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L38) diff --git a/packages/compliance/doc/interfaces/Errors.md b/packages/compliance/doc/interfaces/Errors.md deleted file mode 100644 index 21bbc9e4d..000000000 --- a/packages/compliance/doc/interfaces/Errors.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / Errors - -# Interface: Errors - -**`Export`** - -Errors - -## Table of contents - -### Properties - -- [errors](Errors.md#errors) - -## Properties - -### errors - -• **errors**: `any` - -**`Memberof`** - -Errors - -#### Defined in - -[types/index.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L51) diff --git a/packages/compliance/doc/interfaces/Links.md b/packages/compliance/doc/interfaces/Links.md deleted file mode 100644 index f27d06f81..000000000 --- a/packages/compliance/doc/interfaces/Links.md +++ /dev/null @@ -1,80 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / Links - -# Interface: Links - -**`Export`** - -Links - -## Table of contents - -### Properties - -- [first](Links.md#first) -- [last](Links.md#last) -- [next](Links.md#next) -- [previous](Links.md#previous) - -## Properties - -### first - -• `Optional` **first**: `any` - -Link to first page - -**`Memberof`** - -Links - -#### Defined in - -[types/index.ts:64](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L64) - -___ - -### last - -• `Optional` **last**: `any` - -Link to last page - -**`Memberof`** - -Links - -#### Defined in - -[types/index.ts:70](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L70) - -___ - -### next - -• `Optional` **next**: `any` - -Link to next page - -**`Memberof`** - -Links - -#### Defined in - -[types/index.ts:82](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L82) - -___ - -### previous - -• `Optional` **previous**: `any` - -Link to previous page - -**`Memberof`** - -Links - -#### Defined in - -[types/index.ts:76](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L76) diff --git a/packages/compliance/doc/interfaces/Metadata.md b/packages/compliance/doc/interfaces/Metadata.md deleted file mode 100644 index 0fd54dddb..000000000 --- a/packages/compliance/doc/interfaces/Metadata.md +++ /dev/null @@ -1,97 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / Metadata - -# Interface: Metadata - -**`Export`** - -Metadata - -## Table of contents - -### Properties - -- [filter](Metadata.md#filter) -- [limit](Metadata.md#limit) -- [offset](Metadata.md#offset) -- [sort\_by](Metadata.md#sort_by) -- [total](Metadata.md#total) - -## Properties - -### filter - -• `Optional` **filter**: `any` - -Query string used to filter items by their attributes - -**`Memberof`** - -Metadata - -#### Defined in - -[types/index.ts:119](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L119) - -___ - -### limit - -• `Optional` **limit**: `any` - -Number of items returned per page - -**`Memberof`** - -Metadata - -#### Defined in - -[types/index.ts:101](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L101) - -___ - -### offset - -• `Optional` **offset**: `any` - -Offset of the first item of paginated response - -**`Memberof`** - -Metadata - -#### Defined in - -[types/index.ts:107](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L107) - -___ - -### sort\_by - -• `Optional` **sort\_by**: `any` - -Attribute and direction the items are sorted by - -**`Memberof`** - -Metadata - -#### Defined in - -[types/index.ts:113](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L113) - -___ - -### total - -• `Optional` **total**: `any` - -Total number of items - -**`Memberof`** - -Metadata - -#### Defined in - -[types/index.ts:95](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L95) diff --git a/packages/compliance/doc/interfaces/Policies200Response.md b/packages/compliance/doc/interfaces/Policies200Response.md deleted file mode 100644 index c2da24b42..000000000 --- a/packages/compliance/doc/interfaces/Policies200Response.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / Policies200Response - -# Interface: Policies200Response - -**`Export`** - -Policies200Response - -## Table of contents - -### Properties - -- [data](Policies200Response.md#data) -- [links](Policies200Response.md#links) -- [meta](Policies200Response.md#meta) - -## Properties - -### data - -• `Optional` **data**: `any` - -**`Memberof`** - -Policies200Response - -#### Defined in - -[types/index.ts:144](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L144) - -___ - -### links - -• `Optional` **links**: [`Links`](Links.md) - -**`Memberof`** - -Policies200Response - -#### Defined in - -[types/index.ts:138](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L138) - -___ - -### meta - -• `Optional` **meta**: [`Metadata`](Metadata.md) - -**`Memberof`** - -Policies200Response - -#### Defined in - -[types/index.ts:132](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L132) diff --git a/packages/compliance/doc/interfaces/Policy.md b/packages/compliance/doc/interfaces/Policy.md deleted file mode 100644 index 5fe821b2d..000000000 --- a/packages/compliance/doc/interfaces/Policy.md +++ /dev/null @@ -1,195 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / Policy - -# Interface: Policy - -**`Export`** - -Policy - -## Table of contents - -### Properties - -- [business\_objective](Policy.md#business_objective) -- [compliance\_threshold](Policy.md#compliance_threshold) -- [description](Policy.md#description) -- [id](Policy.md#id) -- [os\_major\_version](Policy.md#os_major_version) -- [profile\_id](Policy.md#profile_id) -- [profile\_title](Policy.md#profile_title) -- [ref\_id](Policy.md#ref_id) -- [title](Policy.md#title) -- [total\_system\_count](Policy.md#total_system_count) -- [type](Policy.md#type) - -## Properties - -### business\_objective - -• `Optional` **business\_objective**: `any` - -The Business Objective associated to the Policy - -**`Memberof`** - -Policy - -#### Defined in - -[types/index.ts:181](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L181) - -___ - -### compliance\_threshold - -• **compliance\_threshold**: `any` - -The percentage above which the Policy meets compliance requirements - -**`Memberof`** - -Policy - -#### Defined in - -[types/index.ts:187](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L187) - -___ - -### description - -• `Optional` **description**: `any` - -Longer description of the Policy - -**`Memberof`** - -Policy - -#### Defined in - -[types/index.ts:175](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L175) - -___ - -### id - -• `Optional` **id**: `any` - -**`Memberof`** - -Policy - -#### Defined in - -[types/index.ts:157](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L157) - -___ - -### os\_major\_version - -• `Optional` **os\_major\_version**: `any` - -Major version of the Operating System that the Policy covers - -**`Memberof`** - -Policy - -#### Defined in - -[types/index.ts:199](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L199) - -___ - -### profile\_id - -• **profile\_id**: `any` - -Identifier of the underlying Profile - -**`Memberof`** - -Policy - -#### Defined in - -[types/index.ts:193](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L193) - -___ - -### profile\_title - -• `Optional` **profile\_title**: `any` - -Title of the associated Policy - -**`Memberof`** - -Policy - -#### Defined in - -[types/index.ts:211](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L211) - -___ - -### ref\_id - -• `Optional` **ref\_id**: `any` - -Identificator of the Profile - -**`Memberof`** - -Policy - -#### Defined in - -[types/index.ts:205](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L205) - -___ - -### title - -• `Optional` **title**: `any` - -Short title of the Policy - -**`Memberof`** - -Policy - -#### Defined in - -[types/index.ts:169](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L169) - -___ - -### total\_system\_count - -• `Optional` **total\_system\_count**: `any` - -The number of Systems assigned to this Policy - -**`Memberof`** - -Policy - -#### Defined in - -[types/index.ts:217](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L217) - -___ - -### type - -• `Optional` **type**: ``"policy"`` - -**`Memberof`** - -Policy - -#### Defined in - -[types/index.ts:163](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L163) diff --git a/packages/compliance/doc/interfaces/PolicyUpdate.md b/packages/compliance/doc/interfaces/PolicyUpdate.md deleted file mode 100644 index 795ab213f..000000000 --- a/packages/compliance/doc/interfaces/PolicyUpdate.md +++ /dev/null @@ -1,63 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / PolicyUpdate - -# Interface: PolicyUpdate - -**`Export`** - -PolicyUpdate - -## Table of contents - -### Properties - -- [business\_objective](PolicyUpdate.md#business_objective) -- [compliance\_threshold](PolicyUpdate.md#compliance_threshold) -- [description](PolicyUpdate.md#description) - -## Properties - -### business\_objective - -• `Optional` **business\_objective**: `any` - -The Business Objective associated to the Policy - -**`Memberof`** - -PolicyUpdate - -#### Defined in - -[types/index.ts:243](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L243) - -___ - -### compliance\_threshold - -• `Optional` **compliance\_threshold**: `any` - -The percentage above which the Policy meets compliance requirements - -**`Memberof`** - -PolicyUpdate - -#### Defined in - -[types/index.ts:249](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L249) - -___ - -### description - -• `Optional` **description**: `any` - -Longer description of the Policy - -**`Memberof`** - -PolicyUpdate - -#### Defined in - -[types/index.ts:237](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L237) diff --git a/packages/compliance/doc/interfaces/Profile.md b/packages/compliance/doc/interfaces/Profile.md deleted file mode 100644 index ca0b1c9f9..000000000 --- a/packages/compliance/doc/interfaces/Profile.md +++ /dev/null @@ -1,110 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / Profile - -# Interface: Profile - -**`Export`** - -Profile - -## Table of contents - -### Properties - -- [description](Profile.md#description) -- [id](Profile.md#id) -- [ref\_id](Profile.md#ref_id) -- [title](Profile.md#title) -- [type](Profile.md#type) -- [value\_overrides](Profile.md#value_overrides) - -## Properties - -### description - -• `Optional` **description**: `any` - -Longer description of the Profile - -**`Memberof`** - -Profile - -#### Defined in - -[types/index.ts:286](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L286) - -___ - -### id - -• `Optional` **id**: `any` - -**`Memberof`** - -Profile - -#### Defined in - -[types/index.ts:262](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L262) - -___ - -### ref\_id - -• `Optional` **ref\_id**: `any` - -Identificator of the Profile - -**`Memberof`** - -Profile - -#### Defined in - -[types/index.ts:274](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L274) - -___ - -### title - -• `Optional` **title**: `any` - -Short title of the Profile - -**`Memberof`** - -Profile - -#### Defined in - -[types/index.ts:280](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L280) - -___ - -### type - -• `Optional` **type**: ``"profile"`` - -**`Memberof`** - -Profile - -#### Defined in - -[types/index.ts:268](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L268) - -___ - -### value\_overrides - -• `Optional` **value\_overrides**: `any` - -Pair of keys and values for Value Definition customizations - -**`Memberof`** - -Profile - -#### Defined in - -[types/index.ts:292](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L292) diff --git a/packages/compliance/doc/interfaces/Profile200Response.md b/packages/compliance/doc/interfaces/Profile200Response.md deleted file mode 100644 index 539d70431..000000000 --- a/packages/compliance/doc/interfaces/Profile200Response.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / Profile200Response - -# Interface: Profile200Response - -**`Export`** - -Profile200Response - -## Table of contents - -### Properties - -- [data](Profile200Response.md#data) - -## Properties - -### data - -• `Optional` **data**: [`Profile200ResponseData`](Profile200ResponseData.md) - -**`Memberof`** - -Profile200Response - -#### Defined in - -[types/index.ts:312](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L312) diff --git a/packages/compliance/doc/interfaces/Profile200ResponseData.md b/packages/compliance/doc/interfaces/Profile200ResponseData.md deleted file mode 100644 index 15a4087e4..000000000 --- a/packages/compliance/doc/interfaces/Profile200ResponseData.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / Profile200ResponseData - -# Interface: Profile200ResponseData - -**`Export`** - -Profile200ResponseData - -## Table of contents - -### Properties - -- [schema](Profile200ResponseData.md#schema) - -## Properties - -### schema - -• `Optional` **schema**: [`Profile`](Profile.md) - -**`Memberof`** - -Profile200ResponseData - -#### Defined in - -[types/index.ts:325](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L325) diff --git a/packages/compliance/doc/interfaces/Profiles200Response.md b/packages/compliance/doc/interfaces/Profiles200Response.md deleted file mode 100644 index c4c8dd64e..000000000 --- a/packages/compliance/doc/interfaces/Profiles200Response.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / Profiles200Response - -# Interface: Profiles200Response - -**`Export`** - -Profiles200Response - -## Table of contents - -### Properties - -- [data](Profiles200Response.md#data) -- [links](Profiles200Response.md#links) -- [meta](Profiles200Response.md#meta) - -## Properties - -### data - -• `Optional` **data**: `any` - -**`Memberof`** - -Profiles200Response - -#### Defined in - -[types/index.ts:350](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L350) - -___ - -### links - -• `Optional` **links**: [`Links`](Links.md) - -**`Memberof`** - -Profiles200Response - -#### Defined in - -[types/index.ts:344](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L344) - -___ - -### meta - -• `Optional` **meta**: [`Metadata`](Metadata.md) - -**`Memberof`** - -Profiles200Response - -#### Defined in - -[types/index.ts:338](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L338) diff --git a/packages/compliance/doc/interfaces/Report.md b/packages/compliance/doc/interfaces/Report.md deleted file mode 100644 index 19a1823a1..000000000 --- a/packages/compliance/doc/interfaces/Report.md +++ /dev/null @@ -1,229 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / Report - -# Interface: Report - -**`Export`** - -Report - -## Table of contents - -### Properties - -- [all\_systems\_exposed](Report.md#all_systems_exposed) -- [assigned\_system\_count](Report.md#assigned_system_count) -- [business\_objective](Report.md#business_objective) -- [compliance\_threshold](Report.md#compliance_threshold) -- [compliant\_system\_count](Report.md#compliant_system_count) -- [id](Report.md#id) -- [os\_major\_version](Report.md#os_major_version) -- [profile\_title](Report.md#profile_title) -- [ref\_id](Report.md#ref_id) -- [reported\_system\_count](Report.md#reported_system_count) -- [title](Report.md#title) -- [type](Report.md#type) -- [unsupported\_system\_count](Report.md#unsupported_system_count) - -## Properties - -### all\_systems\_exposed - -• `Optional` **all\_systems\_exposed**: `any` - -Informs if the user has access to all the Systems under the Report - -**`Memberof`** - -Report - -#### Defined in - -[types/index.ts:423](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L423) - -___ - -### assigned\_system\_count - -• `Optional` **assigned\_system\_count**: `any` - -The number of Systems assigned to this Report - -**`Memberof`** - -Report - -#### Defined in - -[types/index.ts:411](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L411) - -___ - -### business\_objective - -• `Optional` **business\_objective**: `any` - -The Business Objective associated to the Policy - -**`Memberof`** - -Report - -#### Defined in - -[types/index.ts:381](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L381) - -___ - -### compliance\_threshold - -• `Optional` **compliance\_threshold**: `any` - -The percentage above which the Policy meets compliance requirements - -**`Memberof`** - -Report - -#### Defined in - -[types/index.ts:387](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L387) - -___ - -### compliant\_system\_count - -• `Optional` **compliant\_system\_count**: `any` - -The number of compliant Systems in this Report - -**`Memberof`** - -Report - -#### Defined in - -[types/index.ts:417](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L417) - -___ - -### id - -• `Optional` **id**: `any` - -**`Memberof`** - -Report - -#### Defined in - -[types/index.ts:363](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L363) - -___ - -### os\_major\_version - -• `Optional` **os\_major\_version**: `any` - -Major version of the Operating System that the Report covers - -**`Memberof`** - -Report - -#### Defined in - -[types/index.ts:393](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L393) - -___ - -### profile\_title - -• `Optional` **profile\_title**: `any` - -Title of the associated Profile - -**`Memberof`** - -Report - -#### Defined in - -[types/index.ts:405](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L405) - -___ - -### ref\_id - -• `Optional` **ref\_id**: `any` - -Identificator of the Profile - -**`Memberof`** - -Report - -#### Defined in - -[types/index.ts:399](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L399) - -___ - -### reported\_system\_count - -• `Optional` **reported\_system\_count**: `any` - -The number of Systems in this Report that have Test Results available - -**`Memberof`** - -Report - -#### Defined in - -[types/index.ts:435](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L435) - -___ - -### title - -• `Optional` **title**: `any` - -Short title of the Report - -**`Memberof`** - -Report - -#### Defined in - -[types/index.ts:375](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L375) - -___ - -### type - -• `Optional` **type**: ``"report"`` - -**`Memberof`** - -Report - -#### Defined in - -[types/index.ts:369](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L369) - -___ - -### unsupported\_system\_count - -• `Optional` **unsupported\_system\_count**: `any` - -The number of unsupported Systems in this Report - -**`Memberof`** - -Report - -#### Defined in - -[types/index.ts:429](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L429) diff --git a/packages/compliance/doc/interfaces/Report200Response.md b/packages/compliance/doc/interfaces/Report200Response.md deleted file mode 100644 index 21d5d9d83..000000000 --- a/packages/compliance/doc/interfaces/Report200Response.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / Report200Response - -# Interface: Report200Response - -**`Export`** - -Report200Response - -## Table of contents - -### Properties - -- [data](Report200Response.md#data) - -## Properties - -### data - -• `Optional` **data**: [`Report200ResponseData`](Report200ResponseData.md) - -**`Memberof`** - -Report200Response - -#### Defined in - -[types/index.ts:455](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L455) diff --git a/packages/compliance/doc/interfaces/Report200ResponseData.md b/packages/compliance/doc/interfaces/Report200ResponseData.md deleted file mode 100644 index f21f1e752..000000000 --- a/packages/compliance/doc/interfaces/Report200ResponseData.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / Report200ResponseData - -# Interface: Report200ResponseData - -**`Export`** - -Report200ResponseData - -## Table of contents - -### Properties - -- [schema](Report200ResponseData.md#schema) - -## Properties - -### schema - -• `Optional` **schema**: [`Report`](Report.md) - -**`Memberof`** - -Report200ResponseData - -#### Defined in - -[types/index.ts:468](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L468) diff --git a/packages/compliance/doc/interfaces/ReportTestResults200Response.md b/packages/compliance/doc/interfaces/ReportTestResults200Response.md deleted file mode 100644 index 5596c2143..000000000 --- a/packages/compliance/doc/interfaces/ReportTestResults200Response.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / ReportTestResults200Response - -# Interface: ReportTestResults200Response - -**`Export`** - -ReportTestResults200Response - -## Table of contents - -### Properties - -- [data](ReportTestResults200Response.md#data) -- [links](ReportTestResults200Response.md#links) -- [meta](ReportTestResults200Response.md#meta) - -## Properties - -### data - -• `Optional` **data**: `any` - -**`Memberof`** - -ReportTestResults200Response - -#### Defined in - -[types/index.ts:493](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L493) - -___ - -### links - -• `Optional` **links**: [`Links`](Links.md) - -**`Memberof`** - -ReportTestResults200Response - -#### Defined in - -[types/index.ts:487](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L487) - -___ - -### meta - -• `Optional` **meta**: [`Metadata`](Metadata.md) - -**`Memberof`** - -ReportTestResults200Response - -#### Defined in - -[types/index.ts:481](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L481) diff --git a/packages/compliance/doc/interfaces/Reports200Response.md b/packages/compliance/doc/interfaces/Reports200Response.md deleted file mode 100644 index 3a7759b31..000000000 --- a/packages/compliance/doc/interfaces/Reports200Response.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / Reports200Response - -# Interface: Reports200Response - -**`Export`** - -Reports200Response - -## Table of contents - -### Properties - -- [data](Reports200Response.md#data) -- [links](Reports200Response.md#links) -- [meta](Reports200Response.md#meta) - -## Properties - -### data - -• `Optional` **data**: `any` - -**`Memberof`** - -Reports200Response - -#### Defined in - -[types/index.ts:518](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L518) - -___ - -### links - -• `Optional` **links**: [`Links`](Links.md) - -**`Memberof`** - -Reports200Response - -#### Defined in - -[types/index.ts:512](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L512) - -___ - -### meta - -• `Optional` **meta**: [`Metadata`](Metadata.md) - -**`Memberof`** - -Reports200Response - -#### Defined in - -[types/index.ts:506](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L506) diff --git a/packages/compliance/doc/interfaces/Rule.md b/packages/compliance/doc/interfaces/Rule.md deleted file mode 100644 index 17033dc46..000000000 --- a/packages/compliance/doc/interfaces/Rule.md +++ /dev/null @@ -1,161 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / Rule - -# Interface: Rule - -**`Export`** - -Rule - -## Table of contents - -### Properties - -- [description](Rule.md#description) -- [id](Rule.md#id) -- [precedence](Rule.md#precedence) -- [rationale](Rule.md#rationale) -- [ref\_id](Rule.md#ref_id) -- [remediation\_issue\_id](Rule.md#remediation_issue_id) -- [severity](Rule.md#severity) -- [title](Rule.md#title) -- [type](Rule.md#type) - -## Properties - -### description - -• `Optional` **description**: `any` - -Longer description of the Rule - -**`Memberof`** - -Rule - -#### Defined in - -[types/index.ts:561](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L561) - -___ - -### id - -• `Optional` **id**: `any` - -**`Memberof`** - -Rule - -#### Defined in - -[types/index.ts:531](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L531) - -___ - -### precedence - -• `Optional` **precedence**: `any` - -The original sorting precedence of the Rule in the Security Guide - -**`Memberof`** - -Rule - -#### Defined in - -[types/index.ts:567](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L567) - -___ - -### rationale - -• `Optional` **rationale**: `any` - -Rationale of the Rule - -**`Memberof`** - -Rule - -#### Defined in - -[types/index.ts:555](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L555) - -___ - -### ref\_id - -• `Optional` **ref\_id**: `any` - -Identificator of the Rule - -**`Memberof`** - -Rule - -#### Defined in - -[types/index.ts:543](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L543) - -___ - -### remediation\_issue\_id - -• `Optional` **remediation\_issue\_id**: `any` - -The idenfitier of the remediation associated to this rule, only available under profiles. - -**`Memberof`** - -Rule - -#### Defined in - -[types/index.ts:579](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L579) - -___ - -### severity - -• `Optional` **severity**: `any` - -The severity of the Rule - -**`Memberof`** - -Rule - -#### Defined in - -[types/index.ts:573](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L573) - -___ - -### title - -• `Optional` **title**: `any` - -Short title of the Rule - -**`Memberof`** - -Rule - -#### Defined in - -[types/index.ts:549](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L549) - -___ - -### type - -• `Optional` **type**: ``"rule"`` - -**`Memberof`** - -Rule - -#### Defined in - -[types/index.ts:537](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L537) diff --git a/packages/compliance/doc/interfaces/Rule200Response.md b/packages/compliance/doc/interfaces/Rule200Response.md deleted file mode 100644 index 0136be4b5..000000000 --- a/packages/compliance/doc/interfaces/Rule200Response.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / Rule200Response - -# Interface: Rule200Response - -**`Export`** - -Rule200Response - -## Table of contents - -### Properties - -- [data](Rule200Response.md#data) - -## Properties - -### data - -• `Optional` **data**: [`Rule200ResponseData`](Rule200ResponseData.md) - -**`Memberof`** - -Rule200Response - -#### Defined in - -[types/index.ts:599](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L599) diff --git a/packages/compliance/doc/interfaces/Rule200ResponseData.md b/packages/compliance/doc/interfaces/Rule200ResponseData.md deleted file mode 100644 index bc02cb0f0..000000000 --- a/packages/compliance/doc/interfaces/Rule200ResponseData.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / Rule200ResponseData - -# Interface: Rule200ResponseData - -**`Export`** - -Rule200ResponseData - -## Table of contents - -### Properties - -- [schema](Rule200ResponseData.md#schema) - -## Properties - -### schema - -• `Optional` **schema**: [`Rule`](Rule.md) - -**`Memberof`** - -Rule200ResponseData - -#### Defined in - -[types/index.ts:612](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L612) diff --git a/packages/compliance/doc/interfaces/RuleGroup.md b/packages/compliance/doc/interfaces/RuleGroup.md deleted file mode 100644 index c0fc0aeef..000000000 --- a/packages/compliance/doc/interfaces/RuleGroup.md +++ /dev/null @@ -1,127 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / RuleGroup - -# Interface: RuleGroup - -**`Export`** - -RuleGroup - -## Table of contents - -### Properties - -- [description](RuleGroup.md#description) -- [id](RuleGroup.md#id) -- [precedence](RuleGroup.md#precedence) -- [rationale](RuleGroup.md#rationale) -- [ref\_id](RuleGroup.md#ref_id) -- [title](RuleGroup.md#title) -- [type](RuleGroup.md#type) - -## Properties - -### description - -• `Optional` **description**: `any` - -Longer description of the Rule Group - -**`Memberof`** - -RuleGroup - -#### Defined in - -[types/index.ts:655](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L655) - -___ - -### id - -• `Optional` **id**: `any` - -**`Memberof`** - -RuleGroup - -#### Defined in - -[types/index.ts:625](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L625) - -___ - -### precedence - -• `Optional` **precedence**: `any` - -The original sorting precedence of the Rule Group in the Security Guide - -**`Memberof`** - -RuleGroup - -#### Defined in - -[types/index.ts:661](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L661) - -___ - -### rationale - -• `Optional` **rationale**: `any` - -Rationale of the Rule Group - -**`Memberof`** - -RuleGroup - -#### Defined in - -[types/index.ts:649](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L649) - -___ - -### ref\_id - -• `Optional` **ref\_id**: `any` - -Identificator of the Rule Group - -**`Memberof`** - -RuleGroup - -#### Defined in - -[types/index.ts:637](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L637) - -___ - -### title - -• `Optional` **title**: `any` - -Short title of the Rule Group - -**`Memberof`** - -RuleGroup - -#### Defined in - -[types/index.ts:643](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L643) - -___ - -### type - -• `Optional` **type**: ``"rule_group"`` - -**`Memberof`** - -RuleGroup - -#### Defined in - -[types/index.ts:631](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L631) diff --git a/packages/compliance/doc/interfaces/RuleGroup200Response.md b/packages/compliance/doc/interfaces/RuleGroup200Response.md deleted file mode 100644 index 884faa96f..000000000 --- a/packages/compliance/doc/interfaces/RuleGroup200Response.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / RuleGroup200Response - -# Interface: RuleGroup200Response - -**`Export`** - -RuleGroup200Response - -## Table of contents - -### Properties - -- [data](RuleGroup200Response.md#data) - -## Properties - -### data - -• `Optional` **data**: [`RuleGroup200ResponseData`](RuleGroup200ResponseData.md) - -**`Memberof`** - -RuleGroup200Response - -#### Defined in - -[types/index.ts:681](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L681) diff --git a/packages/compliance/doc/interfaces/RuleGroup200ResponseData.md b/packages/compliance/doc/interfaces/RuleGroup200ResponseData.md deleted file mode 100644 index b8806e599..000000000 --- a/packages/compliance/doc/interfaces/RuleGroup200ResponseData.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / RuleGroup200ResponseData - -# Interface: RuleGroup200ResponseData - -**`Export`** - -RuleGroup200ResponseData - -## Table of contents - -### Properties - -- [schema](RuleGroup200ResponseData.md#schema) - -## Properties - -### schema - -• `Optional` **schema**: [`RuleGroup`](RuleGroup.md) - -**`Memberof`** - -RuleGroup200ResponseData - -#### Defined in - -[types/index.ts:694](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L694) diff --git a/packages/compliance/doc/interfaces/RuleGroups200Response.md b/packages/compliance/doc/interfaces/RuleGroups200Response.md deleted file mode 100644 index 73f30d874..000000000 --- a/packages/compliance/doc/interfaces/RuleGroups200Response.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / RuleGroups200Response - -# Interface: RuleGroups200Response - -**`Export`** - -RuleGroups200Response - -## Table of contents - -### Properties - -- [data](RuleGroups200Response.md#data) -- [links](RuleGroups200Response.md#links) -- [meta](RuleGroups200Response.md#meta) - -## Properties - -### data - -• `Optional` **data**: `any` - -**`Memberof`** - -RuleGroups200Response - -#### Defined in - -[types/index.ts:719](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L719) - -___ - -### links - -• `Optional` **links**: [`Links`](Links.md) - -**`Memberof`** - -RuleGroups200Response - -#### Defined in - -[types/index.ts:713](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L713) - -___ - -### meta - -• `Optional` **meta**: [`Metadata`](Metadata.md) - -**`Memberof`** - -RuleGroups200Response - -#### Defined in - -[types/index.ts:707](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L707) diff --git a/packages/compliance/doc/interfaces/Rules200Response.md b/packages/compliance/doc/interfaces/Rules200Response.md deleted file mode 100644 index 92b5126ce..000000000 --- a/packages/compliance/doc/interfaces/Rules200Response.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / Rules200Response - -# Interface: Rules200Response - -**`Export`** - -Rules200Response - -## Table of contents - -### Properties - -- [data](Rules200Response.md#data) -- [links](Rules200Response.md#links) -- [meta](Rules200Response.md#meta) - -## Properties - -### data - -• `Optional` **data**: `any` - -**`Memberof`** - -Rules200Response - -#### Defined in - -[types/index.ts:744](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L744) - -___ - -### links - -• `Optional` **links**: [`Links`](Links.md) - -**`Memberof`** - -Rules200Response - -#### Defined in - -[types/index.ts:738](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L738) - -___ - -### meta - -• `Optional` **meta**: [`Metadata`](Metadata.md) - -**`Memberof`** - -Rules200Response - -#### Defined in - -[types/index.ts:732](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L732) diff --git a/packages/compliance/doc/interfaces/SecurityGuide.md b/packages/compliance/doc/interfaces/SecurityGuide.md deleted file mode 100644 index 18f657d03..000000000 --- a/packages/compliance/doc/interfaces/SecurityGuide.md +++ /dev/null @@ -1,127 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / SecurityGuide - -# Interface: SecurityGuide - -**`Export`** - -SecurityGuide - -## Table of contents - -### Properties - -- [description](SecurityGuide.md#description) -- [id](SecurityGuide.md#id) -- [os\_major\_version](SecurityGuide.md#os_major_version) -- [ref\_id](SecurityGuide.md#ref_id) -- [title](SecurityGuide.md#title) -- [type](SecurityGuide.md#type) -- [version](SecurityGuide.md#version) - -## Properties - -### description - -• `Optional` **description**: `any` - -Longer description of the Security Guide - -**`Memberof`** - -SecurityGuide - -#### Defined in - -[types/index.ts:787](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L787) - -___ - -### id - -• `Optional` **id**: `any` - -**`Memberof`** - -SecurityGuide - -#### Defined in - -[types/index.ts:757](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L757) - -___ - -### os\_major\_version - -• `Optional` **os\_major\_version**: `any` - -Major version of the Operating System that the Security Guide covers - -**`Memberof`** - -SecurityGuide - -#### Defined in - -[types/index.ts:793](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L793) - -___ - -### ref\_id - -• `Optional` **ref\_id**: `any` - -Identificator of the Security Guide - -**`Memberof`** - -SecurityGuide - -#### Defined in - -[types/index.ts:769](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L769) - -___ - -### title - -• `Optional` **title**: `any` - -Short title of the Security Guide - -**`Memberof`** - -SecurityGuide - -#### Defined in - -[types/index.ts:775](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L775) - -___ - -### type - -• `Optional` **type**: ``"security_guide"`` - -**`Memberof`** - -SecurityGuide - -#### Defined in - -[types/index.ts:763](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L763) - -___ - -### version - -• `Optional` **version**: `any` - -Version of the Security Guide - -**`Memberof`** - -SecurityGuide - -#### Defined in - -[types/index.ts:781](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L781) diff --git a/packages/compliance/doc/interfaces/SecurityGuide200Response.md b/packages/compliance/doc/interfaces/SecurityGuide200Response.md deleted file mode 100644 index df852337c..000000000 --- a/packages/compliance/doc/interfaces/SecurityGuide200Response.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / SecurityGuide200Response - -# Interface: SecurityGuide200Response - -**`Export`** - -SecurityGuide200Response - -## Table of contents - -### Properties - -- [data](SecurityGuide200Response.md#data) - -## Properties - -### data - -• `Optional` **data**: [`SecurityGuide200ResponseData`](SecurityGuide200ResponseData.md) - -**`Memberof`** - -SecurityGuide200Response - -#### Defined in - -[types/index.ts:813](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L813) diff --git a/packages/compliance/doc/interfaces/SecurityGuide200ResponseData.md b/packages/compliance/doc/interfaces/SecurityGuide200ResponseData.md deleted file mode 100644 index ab9417ce9..000000000 --- a/packages/compliance/doc/interfaces/SecurityGuide200ResponseData.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / SecurityGuide200ResponseData - -# Interface: SecurityGuide200ResponseData - -**`Export`** - -SecurityGuide200ResponseData - -## Table of contents - -### Properties - -- [schema](SecurityGuide200ResponseData.md#schema) - -## Properties - -### schema - -• `Optional` **schema**: [`SecurityGuide`](SecurityGuide.md) - -**`Memberof`** - -SecurityGuide200ResponseData - -#### Defined in - -[types/index.ts:826](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L826) diff --git a/packages/compliance/doc/interfaces/SecurityGuides200Response.md b/packages/compliance/doc/interfaces/SecurityGuides200Response.md deleted file mode 100644 index 30194364f..000000000 --- a/packages/compliance/doc/interfaces/SecurityGuides200Response.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / SecurityGuides200Response - -# Interface: SecurityGuides200Response - -**`Export`** - -SecurityGuides200Response - -## Table of contents - -### Properties - -- [data](SecurityGuides200Response.md#data) -- [links](SecurityGuides200Response.md#links) -- [meta](SecurityGuides200Response.md#meta) - -## Properties - -### data - -• `Optional` **data**: `any` - -**`Memberof`** - -SecurityGuides200Response - -#### Defined in - -[types/index.ts:851](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L851) - -___ - -### links - -• `Optional` **links**: [`Links`](Links.md) - -**`Memberof`** - -SecurityGuides200Response - -#### Defined in - -[types/index.ts:845](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L845) - -___ - -### meta - -• `Optional` **meta**: [`Metadata`](Metadata.md) - -**`Memberof`** - -SecurityGuides200Response - -#### Defined in - -[types/index.ts:839](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L839) diff --git a/packages/compliance/doc/interfaces/SupportedProfile.md b/packages/compliance/doc/interfaces/SupportedProfile.md deleted file mode 100644 index 5cee3896b..000000000 --- a/packages/compliance/doc/interfaces/SupportedProfile.md +++ /dev/null @@ -1,144 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / SupportedProfile - -# Interface: SupportedProfile - -**`Export`** - -SupportedProfile - -## Table of contents - -### Properties - -- [id](SupportedProfile.md#id) -- [os\_major\_version](SupportedProfile.md#os_major_version) -- [os\_minor\_versions](SupportedProfile.md#os_minor_versions) -- [ref\_id](SupportedProfile.md#ref_id) -- [security\_guide\_id](SupportedProfile.md#security_guide_id) -- [security\_guide\_version](SupportedProfile.md#security_guide_version) -- [title](SupportedProfile.md#title) -- [type](SupportedProfile.md#type) - -## Properties - -### id - -• `Optional` **id**: `any` - -**`Memberof`** - -SupportedProfile - -#### Defined in - -[types/index.ts:864](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L864) - -___ - -### os\_major\_version - -• `Optional` **os\_major\_version**: `any` - -Major version of the Operating System that the Profile covers - -**`Memberof`** - -SupportedProfile - -#### Defined in - -[types/index.ts:900](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L900) - -___ - -### os\_minor\_versions - -• `Optional` **os\_minor\_versions**: `any` - -List of the supported Operating System minor versions that the Profile covers - -**`Memberof`** - -SupportedProfile - -#### Defined in - -[types/index.ts:906](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L906) - -___ - -### ref\_id - -• `Optional` **ref\_id**: `any` - -Identificator of the latest supported Profile - -**`Memberof`** - -SupportedProfile - -#### Defined in - -[types/index.ts:876](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L876) - -___ - -### security\_guide\_id - -• `Optional` **security\_guide\_id**: `any` - -UUID of the latest Security Guide supporting this Profile - -**`Memberof`** - -SupportedProfile - -#### Defined in - -[types/index.ts:888](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L888) - -___ - -### security\_guide\_version - -• `Optional` **security\_guide\_version**: `any` - -Version of the latest Security Guide supporting this Profile - -**`Memberof`** - -SupportedProfile - -#### Defined in - -[types/index.ts:894](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L894) - -___ - -### title - -• `Optional` **title**: `any` - -Short title of the Profile - -**`Memberof`** - -SupportedProfile - -#### Defined in - -[types/index.ts:882](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L882) - -___ - -### type - -• `Optional` **type**: ``"supported_profile"`` - -**`Memberof`** - -SupportedProfile - -#### Defined in - -[types/index.ts:870](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L870) diff --git a/packages/compliance/doc/interfaces/SupportedProfiles200Response.md b/packages/compliance/doc/interfaces/SupportedProfiles200Response.md deleted file mode 100644 index f408310c5..000000000 --- a/packages/compliance/doc/interfaces/SupportedProfiles200Response.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / SupportedProfiles200Response - -# Interface: SupportedProfiles200Response - -**`Export`** - -SupportedProfiles200Response - -## Table of contents - -### Properties - -- [data](SupportedProfiles200Response.md#data) -- [links](SupportedProfiles200Response.md#links) -- [meta](SupportedProfiles200Response.md#meta) - -## Properties - -### data - -• `Optional` **data**: `any` - -**`Memberof`** - -SupportedProfiles200Response - -#### Defined in - -[types/index.ts:938](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L938) - -___ - -### links - -• `Optional` **links**: [`Links`](Links.md) - -**`Memberof`** - -SupportedProfiles200Response - -#### Defined in - -[types/index.ts:932](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L932) - -___ - -### meta - -• `Optional` **meta**: [`Metadata`](Metadata.md) - -**`Memberof`** - -SupportedProfiles200Response - -#### Defined in - -[types/index.ts:926](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L926) diff --git a/packages/compliance/doc/interfaces/System.md b/packages/compliance/doc/interfaces/System.md deleted file mode 100644 index 89c82c349..000000000 --- a/packages/compliance/doc/interfaces/System.md +++ /dev/null @@ -1,215 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / System - -# Interface: System - -**`Export`** - -System - -## Table of contents - -### Properties - -- [culled\_timestamp](System.md#culled_timestamp) -- [display\_name](System.md#display_name) -- [groups](System.md#groups) -- [id](System.md#id) -- [insights\_id](System.md#insights_id) -- [os\_major\_version](System.md#os_major_version) -- [os\_minor\_version](System.md#os_minor_version) -- [policies](System.md#policies) -- [stale\_timestamp](System.md#stale_timestamp) -- [stale\_warning\_timestamp](System.md#stale_warning_timestamp) -- [tags](System.md#tags) -- [type](System.md#type) -- [updated](System.md#updated) - -## Properties - -### culled\_timestamp - -• `Optional` **culled\_timestamp**: `any` - -**`Memberof`** - -System - -#### Defined in - -[types/index.ts:975](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L975) - -___ - -### display\_name - -• `Optional` **display\_name**: `any` - -Display Name of the System - -**`Memberof`** - -System - -#### Defined in - -[types/index.ts:963](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L963) - -___ - -### groups - -• `Optional` **groups**: `any` - -**`Memberof`** - -System - -#### Defined in - -[types/index.ts:969](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L969) - -___ - -### id - -• `Optional` **id**: `any` - -**`Memberof`** - -System - -#### Defined in - -[types/index.ts:951](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L951) - -___ - -### insights\_id - -• `Optional` **insights\_id**: `any` - -**`Memberof`** - -System - -#### Defined in - -[types/index.ts:999](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L999) - -___ - -### os\_major\_version - -• `Optional` **os\_major\_version**: `any` - -Major version of the Operating System - -**`Memberof`** - -System - -#### Defined in - -[types/index.ts:1011](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1011) - -___ - -### os\_minor\_version - -• `Optional` **os\_minor\_version**: `any` - -Minor version of the Operating System - -**`Memberof`** - -System - -#### Defined in - -[types/index.ts:1017](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1017) - -___ - -### policies - -• `Optional` **policies**: `any` - -List of Policies assigned to the System, visible only when not listing Systems under a given Policy - -**`Memberof`** - -System - -#### Defined in - -[types/index.ts:1023](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1023) - -___ - -### stale\_timestamp - -• `Optional` **stale\_timestamp**: `any` - -**`Memberof`** - -System - -#### Defined in - -[types/index.ts:981](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L981) - -___ - -### stale\_warning\_timestamp - -• `Optional` **stale\_warning\_timestamp**: `any` - -**`Memberof`** - -System - -#### Defined in - -[types/index.ts:987](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L987) - -___ - -### tags - -• `Optional` **tags**: `any` - -**`Memberof`** - -System - -#### Defined in - -[types/index.ts:1005](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1005) - -___ - -### type - -• `Optional` **type**: ``"system"`` - -**`Memberof`** - -System - -#### Defined in - -[types/index.ts:957](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L957) - -___ - -### updated - -• `Optional` **updated**: `any` - -**`Memberof`** - -System - -#### Defined in - -[types/index.ts:993](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L993) diff --git a/packages/compliance/doc/interfaces/System200Response.md b/packages/compliance/doc/interfaces/System200Response.md deleted file mode 100644 index 15ccff7a2..000000000 --- a/packages/compliance/doc/interfaces/System200Response.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / System200Response - -# Interface: System200Response - -**`Export`** - -System200Response - -## Table of contents - -### Properties - -- [data](System200Response.md#data) - -## Properties - -### data - -• `Optional` **data**: [`System200ResponseData`](System200ResponseData.md) - -**`Memberof`** - -System200Response - -#### Defined in - -[types/index.ts:1043](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1043) diff --git a/packages/compliance/doc/interfaces/System200ResponseData.md b/packages/compliance/doc/interfaces/System200ResponseData.md deleted file mode 100644 index a8211607a..000000000 --- a/packages/compliance/doc/interfaces/System200ResponseData.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / System200ResponseData - -# Interface: System200ResponseData - -**`Export`** - -System200ResponseData - -## Table of contents - -### Properties - -- [schema](System200ResponseData.md#schema) - -## Properties - -### schema - -• `Optional` **schema**: [`System`](System.md) - -**`Memberof`** - -System200ResponseData - -#### Defined in - -[types/index.ts:1056](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1056) diff --git a/packages/compliance/doc/interfaces/Systems200Response.md b/packages/compliance/doc/interfaces/Systems200Response.md deleted file mode 100644 index a7b13618b..000000000 --- a/packages/compliance/doc/interfaces/Systems200Response.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / Systems200Response - -# Interface: Systems200Response - -**`Export`** - -Systems200Response - -## Table of contents - -### Properties - -- [data](Systems200Response.md#data) -- [links](Systems200Response.md#links) -- [meta](Systems200Response.md#meta) - -## Properties - -### data - -• `Optional` **data**: `any` - -**`Memberof`** - -Systems200Response - -#### Defined in - -[types/index.ts:1081](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1081) - -___ - -### links - -• `Optional` **links**: [`Links`](Links.md) - -**`Memberof`** - -Systems200Response - -#### Defined in - -[types/index.ts:1075](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1075) - -___ - -### meta - -• `Optional` **meta**: [`Metadata`](Metadata.md) - -**`Memberof`** - -Systems200Response - -#### Defined in - -[types/index.ts:1069](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1069) diff --git a/packages/compliance/doc/interfaces/Tailoring.md b/packages/compliance/doc/interfaces/Tailoring.md deleted file mode 100644 index df97e4385..000000000 --- a/packages/compliance/doc/interfaces/Tailoring.md +++ /dev/null @@ -1,127 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / Tailoring - -# Interface: Tailoring - -**`Export`** - -Tailoring - -## Table of contents - -### Properties - -- [id](Tailoring.md#id) -- [os\_major\_version](Tailoring.md#os_major_version) -- [os\_minor\_version](Tailoring.md#os_minor_version) -- [profile\_id](Tailoring.md#profile_id) -- [security\_guide\_id](Tailoring.md#security_guide_id) -- [type](Tailoring.md#type) -- [value\_overrides](Tailoring.md#value_overrides) - -## Properties - -### id - -• `Optional` **id**: `any` - -**`Memberof`** - -Tailoring - -#### Defined in - -[types/index.ts:1094](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1094) - -___ - -### os\_major\_version - -• `Optional` **os\_major\_version**: `any` - -Major version of the Operating System that the Tailoring covers - -**`Memberof`** - -Tailoring - -#### Defined in - -[types/index.ts:1118](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1118) - -___ - -### os\_minor\_version - -• `Optional` **os\_minor\_version**: `any` - -Minor version of the Operating System that the Tailoring covers - -**`Memberof`** - -Tailoring - -#### Defined in - -[types/index.ts:1124](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1124) - -___ - -### profile\_id - -• `Optional` **profile\_id**: `any` - -Identificator of the Profile from which the Tailoring was cloned - -**`Memberof`** - -Tailoring - -#### Defined in - -[types/index.ts:1106](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1106) - -___ - -### security\_guide\_id - -• `Optional` **security\_guide\_id**: `any` - -Identificator of the Security Guide that contains the parent Profile - -**`Memberof`** - -Tailoring - -#### Defined in - -[types/index.ts:1112](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1112) - -___ - -### type - -• `Optional` **type**: ``"tailoring"`` - -**`Memberof`** - -Tailoring - -#### Defined in - -[types/index.ts:1100](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1100) - -___ - -### value\_overrides - -• `Optional` **value\_overrides**: `any` - -Pair of keys and values for Value Definition customizations - -**`Memberof`** - -Tailoring - -#### Defined in - -[types/index.ts:1130](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1130) diff --git a/packages/compliance/doc/interfaces/Tailoring200Response.md b/packages/compliance/doc/interfaces/Tailoring200Response.md deleted file mode 100644 index 98f9178dc..000000000 --- a/packages/compliance/doc/interfaces/Tailoring200Response.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / Tailoring200Response - -# Interface: Tailoring200Response - -**`Export`** - -Tailoring200Response - -## Table of contents - -### Properties - -- [data](Tailoring200Response.md#data) - -## Properties - -### data - -• `Optional` **data**: [`Tailoring200ResponseData`](Tailoring200ResponseData.md) - -**`Memberof`** - -Tailoring200Response - -#### Defined in - -[types/index.ts:1150](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1150) diff --git a/packages/compliance/doc/interfaces/Tailoring200ResponseData.md b/packages/compliance/doc/interfaces/Tailoring200ResponseData.md deleted file mode 100644 index 88944ee3a..000000000 --- a/packages/compliance/doc/interfaces/Tailoring200ResponseData.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / Tailoring200ResponseData - -# Interface: Tailoring200ResponseData - -**`Export`** - -Tailoring200ResponseData - -## Table of contents - -### Properties - -- [schema](Tailoring200ResponseData.md#schema) - -## Properties - -### schema - -• `Optional` **schema**: [`Tailoring`](Tailoring.md) - -**`Memberof`** - -Tailoring200ResponseData - -#### Defined in - -[types/index.ts:1163](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1163) diff --git a/packages/compliance/doc/interfaces/TailoringFile.md b/packages/compliance/doc/interfaces/TailoringFile.md deleted file mode 100644 index 36e4b5eb1..000000000 --- a/packages/compliance/doc/interfaces/TailoringFile.md +++ /dev/null @@ -1,33 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / TailoringFile - -# Interface: TailoringFile - -Defines customizations of rules and variables for a set of profiles - -**`Export`** - -TailoringFile - -## Indexable - -▪ [key: `string`]: `any` - -## Table of contents - -### Properties - -- [profiles](TailoringFile.md#profiles) - -## Properties - -### profiles - -• `Optional` **profiles**: `any` - -**`Memberof`** - -TailoringFile - -#### Defined in - -[types/index.ts:1178](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1178) diff --git a/packages/compliance/doc/interfaces/Tailorings200Response.md b/packages/compliance/doc/interfaces/Tailorings200Response.md deleted file mode 100644 index a6d1ac286..000000000 --- a/packages/compliance/doc/interfaces/Tailorings200Response.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / Tailorings200Response - -# Interface: Tailorings200Response - -**`Export`** - -Tailorings200Response - -## Table of contents - -### Properties - -- [data](Tailorings200Response.md#data) -- [links](Tailorings200Response.md#links) -- [meta](Tailorings200Response.md#meta) - -## Properties - -### data - -• `Optional` **data**: `any` - -**`Memberof`** - -Tailorings200Response - -#### Defined in - -[types/index.ts:1203](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1203) - -___ - -### links - -• `Optional` **links**: [`Links`](Links.md) - -**`Memberof`** - -Tailorings200Response - -#### Defined in - -[types/index.ts:1197](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1197) - -___ - -### meta - -• `Optional` **meta**: [`Metadata`](Metadata.md) - -**`Memberof`** - -Tailorings200Response - -#### Defined in - -[types/index.ts:1191](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1191) diff --git a/packages/compliance/doc/interfaces/TestResult.md b/packages/compliance/doc/interfaces/TestResult.md deleted file mode 100644 index f32f3b7af..000000000 --- a/packages/compliance/doc/interfaces/TestResult.md +++ /dev/null @@ -1,208 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / TestResult - -# Interface: TestResult - -**`Export`** - -TestResult - -## Table of contents - -### Properties - -- [compliant](TestResult.md#compliant) -- [display\_name](TestResult.md#display_name) -- [failed\_rule\_count](TestResult.md#failed_rule_count) -- [groups](TestResult.md#groups) -- [id](TestResult.md#id) -- [last\_scanned](TestResult.md#last_scanned) -- [os\_major\_version](TestResult.md#os_major_version) -- [os\_minor\_version](TestResult.md#os_minor_version) -- [supported](TestResult.md#supported) -- [system\_id](TestResult.md#system_id) -- [tags](TestResult.md#tags) -- [type](TestResult.md#type) - -## Properties - -### compliant - -• `Optional` **compliant**: `any` - -Whether the Test Result is compliant or not within a given Report. - -**`Memberof`** - -TestResult - -#### Defined in - -[types/index.ts:1264](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1264) - -___ - -### display\_name - -• `Optional` **display\_name**: `any` - -Display Name of the System - -**`Memberof`** - -TestResult - -#### Defined in - -[types/index.ts:1228](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1228) - -___ - -### failed\_rule\_count - -• `Optional` **failed\_rule\_count**: `any` - -Number of failed rules in the Test Result - -**`Memberof`** - -TestResult - -#### Defined in - -[types/index.ts:1276](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1276) - -___ - -### groups - -• `Optional` **groups**: `any` - -**`Memberof`** - -TestResult - -#### Defined in - -[types/index.ts:1234](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1234) - -___ - -### id - -• `Optional` **id**: `any` - -**`Memberof`** - -TestResult - -#### Defined in - -[types/index.ts:1216](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1216) - -___ - -### last\_scanned - -• `Optional` **last\_scanned**: `any` - -The date when the System has been reported a Test Result for the last time. - -**`Memberof`** - -TestResult - -#### Defined in - -[types/index.ts:1282](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1282) - -___ - -### os\_major\_version - -• `Optional` **os\_major\_version**: `any` - -Major version of the Operating System - -**`Memberof`** - -TestResult - -#### Defined in - -[types/index.ts:1252](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1252) - -___ - -### os\_minor\_version - -• `Optional` **os\_minor\_version**: `any` - -Minor version of the Operating System - -**`Memberof`** - -TestResult - -#### Defined in - -[types/index.ts:1258](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1258) - -___ - -### supported - -• `Optional` **supported**: `any` - -Whether the System is supported or not by a Profile within a given Policy. - -**`Memberof`** - -TestResult - -#### Defined in - -[types/index.ts:1270](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1270) - -___ - -### system\_id - -• `Optional` **system\_id**: `any` - -UUID of the underlying System - -**`Memberof`** - -TestResult - -#### Defined in - -[types/index.ts:1246](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1246) - -___ - -### tags - -• `Optional` **tags**: `any` - -**`Memberof`** - -TestResult - -#### Defined in - -[types/index.ts:1240](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1240) - -___ - -### type - -• `Optional` **type**: ``"test_result"`` - -**`Memberof`** - -TestResult - -#### Defined in - -[types/index.ts:1222](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1222) diff --git a/packages/compliance/doc/interfaces/ValueDefinition.md b/packages/compliance/doc/interfaces/ValueDefinition.md deleted file mode 100644 index ef0814248..000000000 --- a/packages/compliance/doc/interfaces/ValueDefinition.md +++ /dev/null @@ -1,127 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / ValueDefinition - -# Interface: ValueDefinition - -**`Export`** - -ValueDefinition - -## Table of contents - -### Properties - -- [default\_value](ValueDefinition.md#default_value) -- [description](ValueDefinition.md#description) -- [id](ValueDefinition.md#id) -- [ref\_id](ValueDefinition.md#ref_id) -- [title](ValueDefinition.md#title) -- [type](ValueDefinition.md#type) -- [value\_type](ValueDefinition.md#value_type) - -## Properties - -### default\_value - -• `Optional` **default\_value**: `any` - -Default value of the Value Definition - -**`Memberof`** - -ValueDefinition - -#### Defined in - -[types/index.ts:1338](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1338) - -___ - -### description - -• `Optional` **description**: `any` - -Longer description of the Value Definition - -**`Memberof`** - -ValueDefinition - -#### Defined in - -[types/index.ts:1332](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1332) - -___ - -### id - -• `Optional` **id**: `any` - -**`Memberof`** - -ValueDefinition - -#### Defined in - -[types/index.ts:1302](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1302) - -___ - -### ref\_id - -• `Optional` **ref\_id**: `any` - -Identificator of the Value Definition - -**`Memberof`** - -ValueDefinition - -#### Defined in - -[types/index.ts:1314](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1314) - -___ - -### title - -• `Optional` **title**: `any` - -Short title of the Value Definition - -**`Memberof`** - -ValueDefinition - -#### Defined in - -[types/index.ts:1320](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1320) - -___ - -### type - -• `Optional` **type**: ``"value_definition"`` - -**`Memberof`** - -ValueDefinition - -#### Defined in - -[types/index.ts:1308](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1308) - -___ - -### value\_type - -• `Optional` **value\_type**: `any` - -Type of the Value Definition - -**`Memberof`** - -ValueDefinition - -#### Defined in - -[types/index.ts:1326](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1326) diff --git a/packages/compliance/doc/interfaces/ValueDefinition200Response.md b/packages/compliance/doc/interfaces/ValueDefinition200Response.md deleted file mode 100644 index 7839889bf..000000000 --- a/packages/compliance/doc/interfaces/ValueDefinition200Response.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / ValueDefinition200Response - -# Interface: ValueDefinition200Response - -**`Export`** - -ValueDefinition200Response - -## Table of contents - -### Properties - -- [data](ValueDefinition200Response.md#data) - -## Properties - -### data - -• `Optional` **data**: [`ValueDefinition200ResponseData`](ValueDefinition200ResponseData.md) - -**`Memberof`** - -ValueDefinition200Response - -#### Defined in - -[types/index.ts:1358](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1358) diff --git a/packages/compliance/doc/interfaces/ValueDefinition200ResponseData.md b/packages/compliance/doc/interfaces/ValueDefinition200ResponseData.md deleted file mode 100644 index 7d26a89c9..000000000 --- a/packages/compliance/doc/interfaces/ValueDefinition200ResponseData.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / ValueDefinition200ResponseData - -# Interface: ValueDefinition200ResponseData - -**`Export`** - -ValueDefinition200ResponseData - -## Table of contents - -### Properties - -- [schema](ValueDefinition200ResponseData.md#schema) - -## Properties - -### schema - -• `Optional` **schema**: [`ValueDefinition`](ValueDefinition.md) - -**`Memberof`** - -ValueDefinition200ResponseData - -#### Defined in - -[types/index.ts:1371](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1371) diff --git a/packages/compliance/doc/interfaces/ValueDefinitions200Response.md b/packages/compliance/doc/interfaces/ValueDefinitions200Response.md deleted file mode 100644 index 3ba805256..000000000 --- a/packages/compliance/doc/interfaces/ValueDefinitions200Response.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / ValueDefinitions200Response - -# Interface: ValueDefinitions200Response - -**`Export`** - -ValueDefinitions200Response - -## Table of contents - -### Properties - -- [data](ValueDefinitions200Response.md#data) -- [links](ValueDefinitions200Response.md#links) -- [meta](ValueDefinitions200Response.md#meta) - -## Properties - -### data - -• `Optional` **data**: `any` - -**`Memberof`** - -ValueDefinitions200Response - -#### Defined in - -[types/index.ts:1396](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1396) - -___ - -### links - -• `Optional` **links**: [`Links`](Links.md) - -**`Memberof`** - -ValueDefinitions200Response - -#### Defined in - -[types/index.ts:1390](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1390) - -___ - -### meta - -• `Optional` **meta**: [`Metadata`](Metadata.md) - -**`Memberof`** - -ValueDefinitions200Response - -#### Defined in - -[types/index.ts:1384](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1384) diff --git a/packages/compliance/doc/modules.md b/packages/compliance/doc/modules.md deleted file mode 100644 index 84a43853c..000000000 --- a/packages/compliance/doc/modules.md +++ /dev/null @@ -1,1608 +0,0 @@ -[@redhat-cloud-services/compliance-client](README.md) / Exports - -# @redhat-cloud-services/compliance-client - -## Table of contents - -### Interfaces - -- [AssignRulesRequest](interfaces/AssignRulesRequest.md) -- [CreatePolicy201Response](interfaces/CreatePolicy201Response.md) -- [CreatePolicy201ResponseData](interfaces/CreatePolicy201ResponseData.md) -- [Errors](interfaces/Errors.md) -- [Links](interfaces/Links.md) -- [Metadata](interfaces/Metadata.md) -- [Policies200Response](interfaces/Policies200Response.md) -- [Policy](interfaces/Policy.md) -- [PolicyUpdate](interfaces/PolicyUpdate.md) -- [Profile](interfaces/Profile.md) -- [Profile200Response](interfaces/Profile200Response.md) -- [Profile200ResponseData](interfaces/Profile200ResponseData.md) -- [Profiles200Response](interfaces/Profiles200Response.md) -- [Report](interfaces/Report.md) -- [Report200Response](interfaces/Report200Response.md) -- [Report200ResponseData](interfaces/Report200ResponseData.md) -- [ReportTestResults200Response](interfaces/ReportTestResults200Response.md) -- [Reports200Response](interfaces/Reports200Response.md) -- [Rule](interfaces/Rule.md) -- [Rule200Response](interfaces/Rule200Response.md) -- [Rule200ResponseData](interfaces/Rule200ResponseData.md) -- [RuleGroup](interfaces/RuleGroup.md) -- [RuleGroup200Response](interfaces/RuleGroup200Response.md) -- [RuleGroup200ResponseData](interfaces/RuleGroup200ResponseData.md) -- [RuleGroups200Response](interfaces/RuleGroups200Response.md) -- [Rules200Response](interfaces/Rules200Response.md) -- [SecurityGuide](interfaces/SecurityGuide.md) -- [SecurityGuide200Response](interfaces/SecurityGuide200Response.md) -- [SecurityGuide200ResponseData](interfaces/SecurityGuide200ResponseData.md) -- [SecurityGuides200Response](interfaces/SecurityGuides200Response.md) -- [SupportedProfile](interfaces/SupportedProfile.md) -- [SupportedProfiles200Response](interfaces/SupportedProfiles200Response.md) -- [System](interfaces/System.md) -- [System200Response](interfaces/System200Response.md) -- [System200ResponseData](interfaces/System200ResponseData.md) -- [Systems200Response](interfaces/Systems200Response.md) -- [Tailoring](interfaces/Tailoring.md) -- [Tailoring200Response](interfaces/Tailoring200Response.md) -- [Tailoring200ResponseData](interfaces/Tailoring200ResponseData.md) -- [TailoringFile](interfaces/TailoringFile.md) -- [Tailorings200Response](interfaces/Tailorings200Response.md) -- [TestResult](interfaces/TestResult.md) -- [ValueDefinition](interfaces/ValueDefinition.md) -- [ValueDefinition200Response](interfaces/ValueDefinition200Response.md) -- [ValueDefinition200ResponseData](interfaces/ValueDefinition200ResponseData.md) -- [ValueDefinitions200Response](interfaces/ValueDefinitions200Response.md) - -### Type Aliases - -- [PolicyTypeEnum](modules.md#policytypeenum) -- [ProfileTypeEnum](modules.md#profiletypeenum) -- [ReportTypeEnum](modules.md#reporttypeenum) -- [RuleGroupTypeEnum](modules.md#rulegrouptypeenum) -- [RuleTypeEnum](modules.md#ruletypeenum) -- [SecurityGuideTypeEnum](modules.md#securityguidetypeenum) -- [SupportedProfileTypeEnum](modules.md#supportedprofiletypeenum) -- [SystemTypeEnum](modules.md#systemtypeenum) -- [TailoringTypeEnum](modules.md#tailoringtypeenum) -- [TestResultTypeEnum](modules.md#testresulttypeenum) -- [ValueDefinitionTypeEnum](modules.md#valuedefinitiontypeenum) - -### Variables - -- [PolicyTypeEnum](modules.md#policytypeenum-1) -- [ProfileTypeEnum](modules.md#profiletypeenum-1) -- [ReportTypeEnum](modules.md#reporttypeenum-1) -- [RuleGroupTypeEnum](modules.md#rulegrouptypeenum-1) -- [RuleTypeEnum](modules.md#ruletypeenum-1) -- [SecurityGuideTypeEnum](modules.md#securityguidetypeenum-1) -- [SupportedProfileTypeEnum](modules.md#supportedprofiletypeenum-1) -- [SystemTypeEnum](modules.md#systemtypeenum-1) -- [TailoringTypeEnum](modules.md#tailoringtypeenum-1) -- [TestResultTypeEnum](modules.md#testresulttypeenum-1) -- [ValueDefinitionTypeEnum](modules.md#valuedefinitiontypeenum-1) - -### Functions - -- [assignRule](modules.md#assignrule) -- [assignRules](modules.md#assignrules) -- [assignSystem](modules.md#assignsystem) -- [assignSystems](modules.md#assignsystems) -- [createPolicy](modules.md#createpolicy) -- [deletePolicy](modules.md#deletepolicy) -- [deleteReport](modules.md#deletereport) -- [policies](modules.md#policies) -- [policy](modules.md#policy) -- [policySystems](modules.md#policysystems) -- [profile](modules.md#profile) -- [profileRule](modules.md#profilerule) -- [profileRules](modules.md#profilerules) -- [profiles](modules.md#profiles) -- [report](modules.md#report) -- [reportSystem](modules.md#reportsystem) -- [reportSystems](modules.md#reportsystems) -- [reportTestResult](modules.md#reporttestresult) -- [reportTestResults](modules.md#reporttestresults) -- [reports](modules.md#reports) -- [rule](modules.md#rule) -- [ruleGroup](modules.md#rulegroup) -- [ruleGroups](modules.md#rulegroups) -- [rules](modules.md#rules) -- [securityGuide](modules.md#securityguide) -- [securityGuideRuleTree](modules.md#securityguideruletree) -- [securityGuides](modules.md#securityguides) -- [supportedProfiles](modules.md#supportedprofiles) -- [system](modules.md#system) -- [systems](modules.md#systems) -- [systemsPolicies](modules.md#systemspolicies) -- [tailoring](modules.md#tailoring) -- [tailoringFile](modules.md#tailoringfile) -- [tailoringRules](modules.md#tailoringrules) -- [tailorings](modules.md#tailorings) -- [unassignRule](modules.md#unassignrule) -- [unassignSystem](modules.md#unassignsystem) -- [updatePolicy](modules.md#updatepolicy) -- [updateTailoring](modules.md#updatetailoring) -- [valueDefinition](modules.md#valuedefinition) -- [valueDefinitions](modules.md#valuedefinitions) - -## Type Aliases - -### PolicyTypeEnum - -Ƭ **PolicyTypeEnum**: typeof [`PolicyTypeEnum`](modules.md#policytypeenum-1)[keyof typeof [`PolicyTypeEnum`](modules.md#policytypeenum-1)] - -#### Defined in - -[types/index.ts:220](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L220) - -[types/index.ts:224](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L224) - -___ - -### ProfileTypeEnum - -Ƭ **ProfileTypeEnum**: typeof [`ProfileTypeEnum`](modules.md#profiletypeenum-1)[keyof typeof [`ProfileTypeEnum`](modules.md#profiletypeenum-1)] - -#### Defined in - -[types/index.ts:295](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L295) - -[types/index.ts:299](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L299) - -___ - -### ReportTypeEnum - -Ƭ **ReportTypeEnum**: typeof [`ReportTypeEnum`](modules.md#reporttypeenum-1)[keyof typeof [`ReportTypeEnum`](modules.md#reporttypeenum-1)] - -#### Defined in - -[types/index.ts:438](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L438) - -[types/index.ts:442](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L442) - -___ - -### RuleGroupTypeEnum - -Ƭ **RuleGroupTypeEnum**: typeof [`RuleGroupTypeEnum`](modules.md#rulegrouptypeenum-1)[keyof typeof [`RuleGroupTypeEnum`](modules.md#rulegrouptypeenum-1)] - -#### Defined in - -[types/index.ts:664](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L664) - -[types/index.ts:668](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L668) - -___ - -### RuleTypeEnum - -Ƭ **RuleTypeEnum**: typeof [`RuleTypeEnum`](modules.md#ruletypeenum-1)[keyof typeof [`RuleTypeEnum`](modules.md#ruletypeenum-1)] - -#### Defined in - -[types/index.ts:582](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L582) - -[types/index.ts:586](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L586) - -___ - -### SecurityGuideTypeEnum - -Ƭ **SecurityGuideTypeEnum**: typeof [`SecurityGuideTypeEnum`](modules.md#securityguidetypeenum-1)[keyof typeof [`SecurityGuideTypeEnum`](modules.md#securityguidetypeenum-1)] - -#### Defined in - -[types/index.ts:796](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L796) - -[types/index.ts:800](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L800) - -___ - -### SupportedProfileTypeEnum - -Ƭ **SupportedProfileTypeEnum**: typeof [`SupportedProfileTypeEnum`](modules.md#supportedprofiletypeenum-1)[keyof typeof [`SupportedProfileTypeEnum`](modules.md#supportedprofiletypeenum-1)] - -#### Defined in - -[types/index.ts:909](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L909) - -[types/index.ts:913](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L913) - -___ - -### SystemTypeEnum - -Ƭ **SystemTypeEnum**: typeof [`SystemTypeEnum`](modules.md#systemtypeenum-1)[keyof typeof [`SystemTypeEnum`](modules.md#systemtypeenum-1)] - -#### Defined in - -[types/index.ts:1026](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1026) - -[types/index.ts:1030](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1030) - -___ - -### TailoringTypeEnum - -Ƭ **TailoringTypeEnum**: typeof [`TailoringTypeEnum`](modules.md#tailoringtypeenum-1)[keyof typeof [`TailoringTypeEnum`](modules.md#tailoringtypeenum-1)] - -#### Defined in - -[types/index.ts:1133](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1133) - -[types/index.ts:1137](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1137) - -___ - -### TestResultTypeEnum - -Ƭ **TestResultTypeEnum**: typeof [`TestResultTypeEnum`](modules.md#testresulttypeenum-1)[keyof typeof [`TestResultTypeEnum`](modules.md#testresulttypeenum-1)] - -#### Defined in - -[types/index.ts:1285](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1285) - -[types/index.ts:1289](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1289) - -___ - -### ValueDefinitionTypeEnum - -Ƭ **ValueDefinitionTypeEnum**: typeof [`ValueDefinitionTypeEnum`](modules.md#valuedefinitiontypeenum-1)[keyof typeof [`ValueDefinitionTypeEnum`](modules.md#valuedefinitiontypeenum-1)] - -#### Defined in - -[types/index.ts:1341](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1341) - -[types/index.ts:1345](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1345) - -## Variables - -### PolicyTypeEnum - -• `Const` **PolicyTypeEnum**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `Policy` | ``"policy"`` | - -#### Defined in - -[types/index.ts:220](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L220) - -[types/index.ts:224](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L224) - -___ - -### ProfileTypeEnum - -• `Const` **ProfileTypeEnum**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `Profile` | ``"profile"`` | - -#### Defined in - -[types/index.ts:295](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L295) - -[types/index.ts:299](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L299) - -___ - -### ReportTypeEnum - -• `Const` **ReportTypeEnum**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `Report` | ``"report"`` | - -#### Defined in - -[types/index.ts:438](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L438) - -[types/index.ts:442](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L442) - -___ - -### RuleGroupTypeEnum - -• `Const` **RuleGroupTypeEnum**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `RuleGroup` | ``"rule_group"`` | - -#### Defined in - -[types/index.ts:664](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L664) - -[types/index.ts:668](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L668) - -___ - -### RuleTypeEnum - -• `Const` **RuleTypeEnum**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `Rule` | ``"rule"`` | - -#### Defined in - -[types/index.ts:582](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L582) - -[types/index.ts:586](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L586) - -___ - -### SecurityGuideTypeEnum - -• `Const` **SecurityGuideTypeEnum**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `SecurityGuide` | ``"security_guide"`` | - -#### Defined in - -[types/index.ts:796](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L796) - -[types/index.ts:800](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L800) - -___ - -### SupportedProfileTypeEnum - -• `Const` **SupportedProfileTypeEnum**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `SupportedProfile` | ``"supported_profile"`` | - -#### Defined in - -[types/index.ts:909](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L909) - -[types/index.ts:913](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L913) - -___ - -### SystemTypeEnum - -• `Const` **SystemTypeEnum**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `System` | ``"system"`` | - -#### Defined in - -[types/index.ts:1026](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1026) - -[types/index.ts:1030](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1030) - -___ - -### TailoringTypeEnum - -• `Const` **TailoringTypeEnum**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `Tailoring` | ``"tailoring"`` | - -#### Defined in - -[types/index.ts:1133](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1133) - -[types/index.ts:1137](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1137) - -___ - -### TestResultTypeEnum - -• `Const` **TestResultTypeEnum**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `TestResult` | ``"test_result"`` | - -#### Defined in - -[types/index.ts:1285](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1285) - -[types/index.ts:1289](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1289) - -___ - -### ValueDefinitionTypeEnum - -• `Const` **ValueDefinitionTypeEnum**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `ValueDefinition` | ``"value_definition"`` | - -#### Defined in - -[types/index.ts:1341](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1341) - -[types/index.ts:1345](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L1345) - -## Functions - -### assignRule - -▸ **assignRule**(`...config`): `Promise`\<`RequestArgs`\> - -Assigns a Rule to a Tailoring - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`AssignRuleParams`] \| [`any`, `any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Assign a Rule to a Tailoring - -**`Throws`** - -#### Defined in - -[AssignRule/index.ts:52](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/AssignRule/index.ts#L52) - -___ - -### assignRules - -▸ **assignRules**(`...config`): `Promise`\<`RequestArgs`\> - -This feature is exclusively used by the frontend - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`AssignRulesParams`] \| [`any`, `any`, `any`, [`AssignRulesRequest`](interfaces/AssignRulesRequest.md), `AxiosRequestConfig`\<`any`\>] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Bulk assign Rules to a Tailoring - -**`Deprecated`** - -**`Throws`** - -#### Defined in - -[AssignRules/index.ts:53](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/AssignRules/index.ts#L53) - -___ - -### assignSystem - -▸ **assignSystem**(`...config`): `Promise`\<`RequestArgs`\> - -Assigns a System to a Policy - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`AssignSystemParams`] \| [`any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Assign a System to a Policy - -**`Throws`** - -#### Defined in - -[AssignSystem/index.ts:46](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/AssignSystem/index.ts#L46) - -___ - -### assignSystems - -▸ **assignSystems**(`...config`): `Promise`\<`RequestArgs`\> - -This feature is exclusively used by the frontend - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`AssignSystemsParams`] \| [`any`, `any`, [`AssignRulesRequest`](interfaces/AssignRulesRequest.md), `AxiosRequestConfig`\<`any`\>] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Bulk assign Systems to a Policy - -**`Deprecated`** - -**`Throws`** - -#### Defined in - -[AssignSystems/index.ts:47](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/AssignSystems/index.ts#L47) - -___ - -### createPolicy - -▸ **createPolicy**(`...config`): `Promise`\<`RequestArgs`\> - -Create a Policy with the provided attributes - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`CreatePolicyParams`] \| [`any`, [`Policy`](interfaces/Policy.md), `AxiosRequestConfig`\<`any`\>] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Create a Policy - -**`Throws`** - -#### Defined in - -[CreatePolicy/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/CreatePolicy/index.ts#L40) - -___ - -### deletePolicy - -▸ **deletePolicy**(`...config`): `Promise`\<`RequestArgs`\> - -Deletes a Policy - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`DeletePolicyParams`] \| [`any`, `any`, `AxiosRequestConfig`\<`any`\>] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Delete a Policy - -**`Throws`** - -#### Defined in - -[DeletePolicy/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/DeletePolicy/index.ts#L40) - -___ - -### deleteReport - -▸ **deleteReport**(`...config`): `Promise`\<`RequestArgs`\> - -Deletes a Report results - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`DeleteReportParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Delete a Report results - -**`Throws`** - -#### Defined in - -DeleteReport/index.ts:40 - -___ - -### policies - -▸ **policies**(`...config`): `Promise`\<`RequestArgs`\> - -Lists Policies - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`PoliciesParams`] \| [`any`, `any`, `any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request Policies - -**`Throws`** - -#### Defined in - -[Policies/index.ts:58](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/Policies/index.ts#L58) - -___ - -### policy - -▸ **policy**(`...config`): `Promise`\<`RequestArgs`\> - -Returns a Policy - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`PolicyParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request a Policy - -**`Throws`** - -#### Defined in - -[Policy/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/Policy/index.ts#L40) - -___ - -### policySystems - -▸ **policySystems**(`...config`): `Promise`\<`RequestArgs`\> - -Lists Systems assigned to a Policy - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`PolicySystemsParams`] \| [`any`, `any`, `any`, `any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request Systems assigned to a Policy - -**`Throws`** - -#### Defined in - -[PolicySystems/index.ts:64](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/PolicySystems/index.ts#L64) - -___ - -### profile - -▸ **profile**(`...config`): `Promise`\<`RequestArgs`\> - -Returns a Profile - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`ProfileParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request a Profile - -**`Throws`** - -#### Defined in - -[Profile/index.ts:46](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/Profile/index.ts#L46) - -___ - -### profileRule - -▸ **profileRule**(`...config`): `Promise`\<`RequestArgs`\> - -Returns a Rule assigned to a Profile - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`ProfileRuleParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request a Rule assigned to a Profile - -**`Throws`** - -#### Defined in - -[ProfileRule/index.ts:52](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/ProfileRule/index.ts#L52) - -___ - -### profileRules - -▸ **profileRules**(`...config`): `Promise`\<`RequestArgs`\> - -Lists Rules assigned to a Profile - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`ProfileRulesParams`] \| [`any`, `any`, `any`, `any`, `any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request Rules assigned to a Profile - -**`Throws`** - -#### Defined in - -[ProfileRules/index.ts:70](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/ProfileRules/index.ts#L70) - -___ - -### profiles - -▸ **profiles**(`...config`): `Promise`\<`RequestArgs`\> - -Lists Profiles - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `any`, `any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`ProfilesParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request Profiles - -**`Throws`** - -#### Defined in - -[Profiles/index.ts:64](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/Profiles/index.ts#L64) - -___ - -### report - -▸ **report**(`...config`): `Promise`\<`RequestArgs`\> - -Returns a Report - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`ReportParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request a Report - -**`Throws`** - -#### Defined in - -[Report/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/Report/index.ts#L40) - -___ - -### reportSystem - -▸ **reportSystem**(`...config`): `Promise`\<`RequestArgs`\> - -Returns a System under a Report - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`ReportSystemParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request a System - -**`Throws`** - -#### Defined in - -ReportSystem/index.ts:46 - -___ - -### reportSystems - -▸ **reportSystems**(`...config`): `Promise`\<`RequestArgs`\> - -Lists Systems assigned to a Report - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `any`, `any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`ReportSystemsParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request Systems assigned to a Report - -**`Throws`** - -#### Defined in - -ReportSystems/index.ts:64 - -___ - -### reportTestResult - -▸ **reportTestResult**(`...config`): `Promise`\<`RequestArgs`\> - -Returns a Test Result under a Report - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`ReportTestResultParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request a Test Result - -**`Throws`** - -#### Defined in - -ReportTestResult/index.ts:46 - -___ - -### reportTestResults - -▸ **reportTestResults**(`...config`): `Promise`\<`RequestArgs`\> - -Lists Test Results under a Report - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `any`, `any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`ReportTestResultsParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request Test Results under a Report - -**`Throws`** - -#### Defined in - -ReportTestResults/index.ts:64 - -___ - -### reports - -▸ **reports**(`...config`): `Promise`\<`RequestArgs`\> - -Lists Reports - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`ReportsParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request Reports - -**`Throws`** - -#### Defined in - -[Reports/index.ts:58](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/Reports/index.ts#L58) - -___ - -### rule - -▸ **rule**(`...config`): `Promise`\<`RequestArgs`\> - -Returns a Rule - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`RuleParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request a Rule - -**`Throws`** - -#### Defined in - -[Rule/index.ts:46](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/Rule/index.ts#L46) - -___ - -### ruleGroup - -▸ **ruleGroup**(`...config`): `Promise`\<`RequestArgs`\> - -Returns a Rule Group - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`RuleGroupParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request a Rule Group - -**`Throws`** - -#### Defined in - -[RuleGroup/index.ts:46](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/RuleGroup/index.ts#L46) - -___ - -### ruleGroups - -▸ **ruleGroups**(`...config`): `Promise`\<`RequestArgs`\> - -Lists Rule Groups - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `any`, `any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`RuleGroupsParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request Rule Groups - -**`Throws`** - -#### Defined in - -[RuleGroups/index.ts:64](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/RuleGroups/index.ts#L64) - -___ - -### rules - -▸ **rules**(`...config`): `Promise`\<`RequestArgs`\> - -Lists Rules assigned - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `any`, `any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`RulesParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request Rules - -**`Throws`** - -#### Defined in - -[Rules/index.ts:64](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/Rules/index.ts#L64) - -___ - -### securityGuide - -▸ **securityGuide**(`...config`): `Promise`\<`RequestArgs`\> - -Returns a Security Guide - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`SecurityGuideParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request a Security Guide - -**`Throws`** - -#### Defined in - -[SecurityGuide/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/SecurityGuide/index.ts#L40) - -___ - -### securityGuideRuleTree - -▸ **securityGuideRuleTree**(`...config`): `Promise`\<`RequestArgs`\> - -Returns the Rule Tree of a Security Guide - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`SecurityGuideRuleTreeParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request the Rule Tree of a Security Guide - -**`Throws`** - -#### Defined in - -[SecurityGuideRuleTree/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/SecurityGuideRuleTree/index.ts#L40) - -___ - -### securityGuides - -▸ **securityGuides**(`...config`): `Promise`\<`RequestArgs`\> - -Lists Security Guides - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`SecurityGuidesParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request Security Guides - -**`Throws`** - -#### Defined in - -[SecurityGuides/index.ts:58](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/SecurityGuides/index.ts#L58) - -___ - -### supportedProfiles - -▸ **supportedProfiles**(`...config`): `Promise`\<`RequestArgs`\> - -Lists Supported Profiles - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`SupportedProfilesParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request Supported Profiles - -**`Throws`** - -#### Defined in - -[SupportedProfiles/index.ts:58](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/SupportedProfiles/index.ts#L58) - -___ - -### system - -▸ **system**(`...config`): `Promise`\<`RequestArgs`\> - -Returns a System - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`SystemParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request a System - -**`Throws`** - -#### Defined in - -[System/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/System/index.ts#L40) - -___ - -### systems - -▸ **systems**(`...config`): `Promise`\<`RequestArgs`\> - -Lists Systems - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`SystemsParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request Systems - -**`Throws`** - -#### Defined in - -[Systems/index.ts:58](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/Systems/index.ts#L58) - -___ - -### systemsPolicies - -▸ **systemsPolicies**(`...config`): `Promise`\<`RequestArgs`\> - -Lists Policies under a System - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `any`, `any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`SystemsPoliciesParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request Policies assigned to a System - -**`Throws`** - -#### Defined in - -[SystemsPolicies/index.ts:64](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/SystemsPolicies/index.ts#L64) - -___ - -### tailoring - -▸ **tailoring**(`...config`): `Promise`\<`RequestArgs`\> - -Returns a Tailoring - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`TailoringParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request a Tailoring - -**`Throws`** - -#### Defined in - -[Tailoring/index.ts:46](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/Tailoring/index.ts#L46) - -___ - -### tailoringFile - -▸ **tailoringFile**(`...config`): `Promise`\<`RequestArgs`\> - -Returns a Tailoring File - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`TailoringFileParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request a Tailoring file - -**`Throws`** - -#### Defined in - -[TailoringFile/index.ts:46](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/TailoringFile/index.ts#L46) - -___ - -### tailoringRules - -▸ **tailoringRules**(`...config`): `Promise`\<`RequestArgs`\> - -Lists Rules assigned to a Tailoring - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `any`, `any`, `any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`TailoringRulesParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request Rules assigned to a Tailoring - -**`Throws`** - -#### Defined in - -[TailoringRules/index.ts:70](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/TailoringRules/index.ts#L70) - -___ - -### tailorings - -▸ **tailorings**(`...config`): `Promise`\<`RequestArgs`\> - -Lists Tailorings - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `any`, `any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`TailoringsParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request Tailorings - -**`Throws`** - -#### Defined in - -[Tailorings/index.ts:64](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/Tailorings/index.ts#L64) - -___ - -### unassignRule - -▸ **unassignRule**(`...config`): `Promise`\<`RequestArgs`\> - -Unassigns a Rule from a Tailoring - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`UnassignRuleParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Unassign a Rule from a Tailoring - -**`Throws`** - -#### Defined in - -[UnassignRule/index.ts:52](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/UnassignRule/index.ts#L52) - -___ - -### unassignSystem - -▸ **unassignSystem**(`...config`): `Promise`\<`RequestArgs`\> - -Unassigns a System from a Policy - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`UnassignSystemParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Unassign a System from a Policy - -**`Throws`** - -#### Defined in - -[UnassignSystem/index.ts:46](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/UnassignSystem/index.ts#L46) - -___ - -### updatePolicy - -▸ **updatePolicy**(`...config`): `Promise`\<`RequestArgs`\> - -Updates a Policy with the provided attributes - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`UpdatePolicyParams`] \| [`any`, `any`, [`PolicyUpdate`](interfaces/PolicyUpdate.md), `AxiosRequestConfig`\<`any`\>] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Update a Policy - -**`Throws`** - -#### Defined in - -[UpdatePolicy/index.ts:46](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/UpdatePolicy/index.ts#L46) - -___ - -### updateTailoring - -▸ **updateTailoring**(`...config`): `Promise`\<`RequestArgs`\> - -Updates a Tailoring with the provided value_overrides - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`UpdateTailoringParams`] \| [`any`, `any`, `any`, [`Tailoring`](interfaces/Tailoring.md), `AxiosRequestConfig`\<`any`\>] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Update a Tailoring - -**`Throws`** - -#### Defined in - -[UpdateTailoring/index.ts:52](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/UpdateTailoring/index.ts#L52) - -___ - -### valueDefinition - -▸ **valueDefinition**(`...config`): `Promise`\<`RequestArgs`\> - -Returns a Value Definition - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`ValueDefinitionParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request a Value Definition - -**`Throws`** - -#### Defined in - -[ValueDefinition/index.ts:46](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/ValueDefinition/index.ts#L46) - -___ - -### valueDefinitions - -▸ **valueDefinitions**(`...config`): `Promise`\<`RequestArgs`\> - -Lists Value Definitions - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...config` | [`any`, `any`, `any`, `any`, `any`, `any`, `AxiosRequestConfig`\<`any`\>] \| [`ValueDefinitionsParams`] | with all available params. | - -#### Returns - -`Promise`\<`RequestArgs`\> - -**`Summary`** - -Request Value Definitions - -**`Throws`** - -#### Defined in - -[ValueDefinitions/index.ts:64](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/ValueDefinitions/index.ts#L64) diff --git a/packages/compliance/jest.config.ts b/packages/compliance/jest.config.ts index 1076f56b0..ea9802cb9 100644 --- a/packages/compliance/jest.config.ts +++ b/packages/compliance/jest.config.ts @@ -7,4 +7,5 @@ export default { }, moduleFileExtensions: ['ts', 'js', 'html'], coverageDirectory: '../../coverage/packages/compliance', + testPathIgnorePatterns: ['/node_modules/','/tests/integration/'], }; diff --git a/packages/compliance/package.json b/packages/compliance/package.json index acf18e3d0..57bec0810 100644 --- a/packages/compliance/package.json +++ b/packages/compliance/package.json @@ -2,32 +2,32 @@ "name": "@redhat-cloud-services/compliance-client", "version": "3.0.7", "description": "TypeScript client for Red Hat Insights Compliance service", - "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/compliance/project.json b/packages/compliance/project.json index 94b1461d5..688d52b3c 100644 --- a/packages/compliance/project.json +++ b/packages/compliance/project.json @@ -4,20 +4,30 @@ "sourceRoot": "packages/compliance", "projectType": "library", "targets": { + "clean-generate": { + "command": "rm -rf packages/compliance/src" + }, "generate": { "executor": "@redhat-cloud-services/build-utils:client-generator", + "dependsOn": ["clean-generate"], "options": { + "outputPath": "packages/compliance/src", "specs": { "default": "https://cloud.redhat.com/api/compliance/v2/openapi.json" }, "clientName": "ComplianceClient" } }, + "clean-build": { + "command": "rm -rf packages/compliance/dist" + }, "build": { "executor": "@redhat-cloud-services/build-utils:builder", + "dependsOn": ["clean-build", "^build"], "options": { + "inputPath": "packages/compliance/src", "outputPath": "packages/compliance/dist", - "main": "packages/compliance/index.ts", + "main": "packages/compliance/src/index.ts", "esmTsConfig": "packages/compliance/tsconfig.esm.json", "cjsTsConfig": "packages/compliance/tsconfig.cjs.json" } @@ -40,6 +50,11 @@ "jestConfig": "packages/compliance/jest.config.ts" } }, + "nx-release-publish": { + "options": { + "packageRoot": "{projectRoot}/dist" + } + }, "npm": { "executor": "ngx-deploy-npm:deploy", "options": { diff --git a/packages/compliance/src/.gitignore b/packages/compliance/src/.gitignore new file mode 100644 index 000000000..149b57654 --- /dev/null +++ b/packages/compliance/src/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/packages/compliance/src/.npmignore b/packages/compliance/src/.npmignore new file mode 100644 index 000000000..6b112e4e7 --- /dev/null +++ b/packages/compliance/src/.npmignore @@ -0,0 +1,6 @@ +.openapi-generator +node_modules +.openapi-generator-ignore +package-lock.json +*.ts +!*.d.ts diff --git a/packages/compliance/src/.openapi-generator-ignore b/packages/compliance/src/.openapi-generator-ignore new file mode 100644 index 000000000..7484ee590 --- /dev/null +++ b/packages/compliance/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/compliance/.openapi-generator/FILES b/packages/compliance/src/.openapi-generator/FILES similarity index 98% rename from packages/compliance/.openapi-generator/FILES rename to packages/compliance/src/.openapi-generator/FILES index f6a0633fb..612ce7ac7 100644 --- a/packages/compliance/.openapi-generator/FILES +++ b/packages/compliance/src/.openapi-generator/FILES @@ -1,5 +1,6 @@ .gitignore .npmignore +.openapi-generator-ignore AssignRule/index.ts AssignRules/index.ts AssignSystem/index.ts diff --git a/packages/compliance/.openapi-generator/VERSION b/packages/compliance/src/.openapi-generator/VERSION similarity index 100% rename from packages/compliance/.openapi-generator/VERSION rename to packages/compliance/src/.openapi-generator/VERSION diff --git a/packages/compliance/AssignRule/index.ts b/packages/compliance/src/AssignRule/index.ts similarity index 100% rename from packages/compliance/AssignRule/index.ts rename to packages/compliance/src/AssignRule/index.ts diff --git a/packages/compliance/AssignRules/index.ts b/packages/compliance/src/AssignRules/index.ts similarity index 100% rename from packages/compliance/AssignRules/index.ts rename to packages/compliance/src/AssignRules/index.ts diff --git a/packages/compliance/AssignSystem/index.ts b/packages/compliance/src/AssignSystem/index.ts similarity index 100% rename from packages/compliance/AssignSystem/index.ts rename to packages/compliance/src/AssignSystem/index.ts diff --git a/packages/compliance/AssignSystems/index.ts b/packages/compliance/src/AssignSystems/index.ts similarity index 100% rename from packages/compliance/AssignSystems/index.ts rename to packages/compliance/src/AssignSystems/index.ts diff --git a/packages/compliance/CreatePolicy/index.ts b/packages/compliance/src/CreatePolicy/index.ts similarity index 100% rename from packages/compliance/CreatePolicy/index.ts rename to packages/compliance/src/CreatePolicy/index.ts diff --git a/packages/compliance/CreateTailoring/index.ts b/packages/compliance/src/CreateTailoring/index.ts similarity index 100% rename from packages/compliance/CreateTailoring/index.ts rename to packages/compliance/src/CreateTailoring/index.ts diff --git a/packages/compliance/DeletePolicy/index.ts b/packages/compliance/src/DeletePolicy/index.ts similarity index 100% rename from packages/compliance/DeletePolicy/index.ts rename to packages/compliance/src/DeletePolicy/index.ts diff --git a/packages/compliance/DeleteReport/index.ts b/packages/compliance/src/DeleteReport/index.ts similarity index 100% rename from packages/compliance/DeleteReport/index.ts rename to packages/compliance/src/DeleteReport/index.ts diff --git a/packages/compliance/Policies/index.ts b/packages/compliance/src/Policies/index.ts similarity index 100% rename from packages/compliance/Policies/index.ts rename to packages/compliance/src/Policies/index.ts diff --git a/packages/compliance/Policy/index.ts b/packages/compliance/src/Policy/index.ts similarity index 100% rename from packages/compliance/Policy/index.ts rename to packages/compliance/src/Policy/index.ts diff --git a/packages/compliance/PolicySystems/index.ts b/packages/compliance/src/PolicySystems/index.ts similarity index 100% rename from packages/compliance/PolicySystems/index.ts rename to packages/compliance/src/PolicySystems/index.ts diff --git a/packages/compliance/PolicySystemsOS/index.ts b/packages/compliance/src/PolicySystemsOS/index.ts similarity index 100% rename from packages/compliance/PolicySystemsOS/index.ts rename to packages/compliance/src/PolicySystemsOS/index.ts diff --git a/packages/compliance/Profile/index.ts b/packages/compliance/src/Profile/index.ts similarity index 100% rename from packages/compliance/Profile/index.ts rename to packages/compliance/src/Profile/index.ts diff --git a/packages/compliance/ProfileRule/index.ts b/packages/compliance/src/ProfileRule/index.ts similarity index 100% rename from packages/compliance/ProfileRule/index.ts rename to packages/compliance/src/ProfileRule/index.ts diff --git a/packages/compliance/ProfileRules/index.ts b/packages/compliance/src/ProfileRules/index.ts similarity index 100% rename from packages/compliance/ProfileRules/index.ts rename to packages/compliance/src/ProfileRules/index.ts diff --git a/packages/compliance/ProfileTree/index.ts b/packages/compliance/src/ProfileTree/index.ts similarity index 100% rename from packages/compliance/ProfileTree/index.ts rename to packages/compliance/src/ProfileTree/index.ts diff --git a/packages/compliance/Profiles/index.ts b/packages/compliance/src/Profiles/index.ts similarity index 100% rename from packages/compliance/Profiles/index.ts rename to packages/compliance/src/Profiles/index.ts diff --git a/packages/compliance/Report/index.ts b/packages/compliance/src/Report/index.ts similarity index 100% rename from packages/compliance/Report/index.ts rename to packages/compliance/src/Report/index.ts diff --git a/packages/compliance/ReportRuleResults/index.ts b/packages/compliance/src/ReportRuleResults/index.ts similarity index 100% rename from packages/compliance/ReportRuleResults/index.ts rename to packages/compliance/src/ReportRuleResults/index.ts diff --git a/packages/compliance/ReportStats/index.ts b/packages/compliance/src/ReportStats/index.ts similarity index 100% rename from packages/compliance/ReportStats/index.ts rename to packages/compliance/src/ReportStats/index.ts diff --git a/packages/compliance/ReportSystem/index.ts b/packages/compliance/src/ReportSystem/index.ts similarity index 100% rename from packages/compliance/ReportSystem/index.ts rename to packages/compliance/src/ReportSystem/index.ts diff --git a/packages/compliance/ReportSystems/index.ts b/packages/compliance/src/ReportSystems/index.ts similarity index 100% rename from packages/compliance/ReportSystems/index.ts rename to packages/compliance/src/ReportSystems/index.ts diff --git a/packages/compliance/ReportSystemsOS/index.ts b/packages/compliance/src/ReportSystemsOS/index.ts similarity index 100% rename from packages/compliance/ReportSystemsOS/index.ts rename to packages/compliance/src/ReportSystemsOS/index.ts diff --git a/packages/compliance/ReportTestResult/index.ts b/packages/compliance/src/ReportTestResult/index.ts similarity index 100% rename from packages/compliance/ReportTestResult/index.ts rename to packages/compliance/src/ReportTestResult/index.ts diff --git a/packages/compliance/ReportTestResults/index.ts b/packages/compliance/src/ReportTestResults/index.ts similarity index 100% rename from packages/compliance/ReportTestResults/index.ts rename to packages/compliance/src/ReportTestResults/index.ts diff --git a/packages/compliance/ReportTestResultsOS/index.ts b/packages/compliance/src/ReportTestResultsOS/index.ts similarity index 100% rename from packages/compliance/ReportTestResultsOS/index.ts rename to packages/compliance/src/ReportTestResultsOS/index.ts diff --git a/packages/compliance/ReportTestResultsSG/index.ts b/packages/compliance/src/ReportTestResultsSG/index.ts similarity index 100% rename from packages/compliance/ReportTestResultsSG/index.ts rename to packages/compliance/src/ReportTestResultsSG/index.ts diff --git a/packages/compliance/Reports/index.ts b/packages/compliance/src/Reports/index.ts similarity index 100% rename from packages/compliance/Reports/index.ts rename to packages/compliance/src/Reports/index.ts diff --git a/packages/compliance/ReportsOS/index.ts b/packages/compliance/src/ReportsOS/index.ts similarity index 100% rename from packages/compliance/ReportsOS/index.ts rename to packages/compliance/src/ReportsOS/index.ts diff --git a/packages/compliance/Rule/index.ts b/packages/compliance/src/Rule/index.ts similarity index 100% rename from packages/compliance/Rule/index.ts rename to packages/compliance/src/Rule/index.ts diff --git a/packages/compliance/RuleGroup/index.ts b/packages/compliance/src/RuleGroup/index.ts similarity index 100% rename from packages/compliance/RuleGroup/index.ts rename to packages/compliance/src/RuleGroup/index.ts diff --git a/packages/compliance/RuleGroups/index.ts b/packages/compliance/src/RuleGroups/index.ts similarity index 100% rename from packages/compliance/RuleGroups/index.ts rename to packages/compliance/src/RuleGroups/index.ts diff --git a/packages/compliance/Rules/index.ts b/packages/compliance/src/Rules/index.ts similarity index 100% rename from packages/compliance/Rules/index.ts rename to packages/compliance/src/Rules/index.ts diff --git a/packages/compliance/SecurityGuide/index.ts b/packages/compliance/src/SecurityGuide/index.ts similarity index 100% rename from packages/compliance/SecurityGuide/index.ts rename to packages/compliance/src/SecurityGuide/index.ts diff --git a/packages/compliance/SecurityGuideRuleTree/index.ts b/packages/compliance/src/SecurityGuideRuleTree/index.ts similarity index 100% rename from packages/compliance/SecurityGuideRuleTree/index.ts rename to packages/compliance/src/SecurityGuideRuleTree/index.ts diff --git a/packages/compliance/SecurityGuides/index.ts b/packages/compliance/src/SecurityGuides/index.ts similarity index 100% rename from packages/compliance/SecurityGuides/index.ts rename to packages/compliance/src/SecurityGuides/index.ts diff --git a/packages/compliance/SecurityGuidesOS/index.ts b/packages/compliance/src/SecurityGuidesOS/index.ts similarity index 100% rename from packages/compliance/SecurityGuidesOS/index.ts rename to packages/compliance/src/SecurityGuidesOS/index.ts diff --git a/packages/compliance/Status/index.ts b/packages/compliance/src/Status/index.ts similarity index 100% rename from packages/compliance/Status/index.ts rename to packages/compliance/src/Status/index.ts diff --git a/packages/compliance/SupportedProfiles/index.ts b/packages/compliance/src/SupportedProfiles/index.ts similarity index 100% rename from packages/compliance/SupportedProfiles/index.ts rename to packages/compliance/src/SupportedProfiles/index.ts diff --git a/packages/compliance/System/index.ts b/packages/compliance/src/System/index.ts similarity index 100% rename from packages/compliance/System/index.ts rename to packages/compliance/src/System/index.ts diff --git a/packages/compliance/SystemReports/index.ts b/packages/compliance/src/SystemReports/index.ts similarity index 100% rename from packages/compliance/SystemReports/index.ts rename to packages/compliance/src/SystemReports/index.ts diff --git a/packages/compliance/Systems/index.ts b/packages/compliance/src/Systems/index.ts similarity index 100% rename from packages/compliance/Systems/index.ts rename to packages/compliance/src/Systems/index.ts diff --git a/packages/compliance/SystemsOS/index.ts b/packages/compliance/src/SystemsOS/index.ts similarity index 100% rename from packages/compliance/SystemsOS/index.ts rename to packages/compliance/src/SystemsOS/index.ts diff --git a/packages/compliance/SystemsPolicies/index.ts b/packages/compliance/src/SystemsPolicies/index.ts similarity index 100% rename from packages/compliance/SystemsPolicies/index.ts rename to packages/compliance/src/SystemsPolicies/index.ts diff --git a/packages/compliance/Tailoring/index.ts b/packages/compliance/src/Tailoring/index.ts similarity index 98% rename from packages/compliance/Tailoring/index.ts rename to packages/compliance/src/Tailoring/index.ts index c3437523a..33b43a4a4 100644 --- a/packages/compliance/Tailoring/index.ts +++ b/packages/compliance/src/Tailoring/index.ts @@ -19,7 +19,7 @@ export type TailoringParams = { */ policyId: any, /** - * UUID or OS minor version number + * UUID **or** OS minor version number * @type { any } * @memberof TailoringApi */ diff --git a/packages/compliance/TailoringFileJSON/index.ts b/packages/compliance/src/TailoringFileJSON/index.ts similarity index 98% rename from packages/compliance/TailoringFileJSON/index.ts rename to packages/compliance/src/TailoringFileJSON/index.ts index ff4bb4863..f2be8693d 100644 --- a/packages/compliance/TailoringFileJSON/index.ts +++ b/packages/compliance/src/TailoringFileJSON/index.ts @@ -19,7 +19,7 @@ export type TailoringFileJSONParams = { */ policyId: any, /** - * UUID or OS minor version number + * UUID **or** OS minor version number * @type { any } * @memberof TailoringFileJSONApi */ diff --git a/packages/compliance/TailoringFileTOML/index.ts b/packages/compliance/src/TailoringFileTOML/index.ts similarity index 97% rename from packages/compliance/TailoringFileTOML/index.ts rename to packages/compliance/src/TailoringFileTOML/index.ts index 38900be5e..b56b74e45 100644 --- a/packages/compliance/TailoringFileTOML/index.ts +++ b/packages/compliance/src/TailoringFileTOML/index.ts @@ -19,7 +19,7 @@ export type TailoringFileTOMLParams = { */ policyId: any, /** - * UUID or OS minor version number + * UUID **or** OS minor version number * @type { any } * @memberof TailoringFileTOMLApi */ @@ -43,7 +43,7 @@ const isTailoringFileTOMLObjectParams = (params: [TailoringFileTOMLParams] | unk return false } /** -* Retrieve a tailoring file of a specific tailoring containing anosbuild blueprint generated by OpenSCAP tooling. +* Retrieve a tailoring file of a specific tailoring containing an osbuild blueprint generated by OpenSCAP tooling. * @summary Request a Tailoring file * @param {TailoringFileTOMLParams} config with all available params. * @param {*} [options] Override http request option. diff --git a/packages/compliance/TailoringRuleTree/index.ts b/packages/compliance/src/TailoringRuleTree/index.ts similarity index 100% rename from packages/compliance/TailoringRuleTree/index.ts rename to packages/compliance/src/TailoringRuleTree/index.ts diff --git a/packages/compliance/TailoringRules/index.ts b/packages/compliance/src/TailoringRules/index.ts similarity index 100% rename from packages/compliance/TailoringRules/index.ts rename to packages/compliance/src/TailoringRules/index.ts diff --git a/packages/compliance/Tailorings/index.ts b/packages/compliance/src/Tailorings/index.ts similarity index 100% rename from packages/compliance/Tailorings/index.ts rename to packages/compliance/src/Tailorings/index.ts diff --git a/packages/compliance/UnassignRule/index.ts b/packages/compliance/src/UnassignRule/index.ts similarity index 100% rename from packages/compliance/UnassignRule/index.ts rename to packages/compliance/src/UnassignRule/index.ts diff --git a/packages/compliance/UnassignSystem/index.ts b/packages/compliance/src/UnassignSystem/index.ts similarity index 100% rename from packages/compliance/UnassignSystem/index.ts rename to packages/compliance/src/UnassignSystem/index.ts diff --git a/packages/compliance/UpdatePolicy/index.ts b/packages/compliance/src/UpdatePolicy/index.ts similarity index 100% rename from packages/compliance/UpdatePolicy/index.ts rename to packages/compliance/src/UpdatePolicy/index.ts diff --git a/packages/compliance/UpdateTailoring/index.ts b/packages/compliance/src/UpdateTailoring/index.ts similarity index 98% rename from packages/compliance/UpdateTailoring/index.ts rename to packages/compliance/src/UpdateTailoring/index.ts index 0da7e75d6..8406f0247 100644 --- a/packages/compliance/UpdateTailoring/index.ts +++ b/packages/compliance/src/UpdateTailoring/index.ts @@ -19,7 +19,7 @@ export type UpdateTailoringParams = { */ policyId: any, /** - * UUID or OS minor version number + * UUID **or** OS minor version number * @type { any } * @memberof UpdateTailoringApi */ diff --git a/packages/compliance/ValueDefinition/index.ts b/packages/compliance/src/ValueDefinition/index.ts similarity index 100% rename from packages/compliance/ValueDefinition/index.ts rename to packages/compliance/src/ValueDefinition/index.ts diff --git a/packages/compliance/ValueDefinitions/index.ts b/packages/compliance/src/ValueDefinitions/index.ts similarity index 100% rename from packages/compliance/ValueDefinitions/index.ts rename to packages/compliance/src/ValueDefinitions/index.ts diff --git a/packages/compliance/api.ts b/packages/compliance/src/api.ts similarity index 100% rename from packages/compliance/api.ts rename to packages/compliance/src/api.ts diff --git a/packages/compliance/index.ts b/packages/compliance/src/index.ts similarity index 98% rename from packages/compliance/index.ts rename to packages/compliance/src/index.ts index 67352fc4c..e352fb7b6 100644 --- a/packages/compliance/index.ts +++ b/packages/compliance/src/index.ts @@ -112,5 +112,3 @@ export { default as valueDefinitions, type ValueDefinitionsReturnType } from './ export * from './types' - -// Trigger release - updated to regenerate clients diff --git a/packages/compliance/types/index.ts b/packages/compliance/src/types/index.ts similarity index 100% rename from packages/compliance/types/index.ts rename to packages/compliance/src/types/index.ts diff --git a/packages/compliance/tsconfig.cjs.json b/packages/compliance/tsconfig.cjs.json index d29a1ef4a..34a67d692 100644 --- a/packages/compliance/tsconfig.cjs.json +++ b/packages/compliance/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/compliance/tsconfig.esm.json b/packages/compliance/tsconfig.esm.json index 28ffe1d28..b611d6c14 100644 --- a/packages/compliance/tsconfig.esm.json +++ b/packages/compliance/tsconfig.esm.json @@ -1,13 +1,22 @@ { "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" + ] } diff --git a/packages/compliance/typedoc.json b/packages/compliance/typedoc.json index b46878455..827d5d040 100644 --- a/packages/compliance/typedoc.json +++ b/packages/compliance/typedoc.json @@ -1,5 +1,5 @@ { - "entryPoints": ["index.ts"], + "entryPoints": ["./src/index.ts"], "out": "doc", "plugin": [ "typedoc-plugin-markdown" diff --git a/tsconfig.base.json b/tsconfig.base.json index 4fbea8247..a64b90747 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -16,7 +16,7 @@ "paths": { "@redhat-cloud-services/build-utils": ["packages/build-utils/src/index.ts"], "@redhat-cloud-services/javascript-clients-shared": ["packages/shared/index.ts"], - "@redhat-cloud-services/compliance-client": ["packages/compliance/index.ts"], + "@redhat-cloud-services/compliance-client": ["packages/compliance/src/index.ts"], "@redhat-cloud-services/config-manager-client": ["packages/config-manager/src/index.ts"], "@redhat-cloud-services/entitlements-client": ["packages/entitlements/src/index.ts"], "@redhat-cloud-services/insights-client": ["packages/insights/src/index.ts"],