@redhat-cloud-services/compliance-client 3.0.6 → 4.0.0

package/doc/interfaces/Rule.md

@@ -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)

package/doc/interfaces/Rule200Response.md

@@ -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)

package/doc/interfaces/Rule200ResponseData.md

@@ -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)

package/doc/interfaces/RuleGroup.md

@@ -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)

package/doc/interfaces/RuleGroup200Response.md

@@ -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)

package/doc/interfaces/RuleGroup200ResponseData.md

@@ -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)

package/doc/interfaces/RuleGroups200Response.md

@@ -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)

package/doc/interfaces/Rules200Response.md

@@ -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)

package/doc/interfaces/SecurityGuide.md

@@ -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)

package/doc/interfaces/SecurityGuide200Response.md

@@ -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)

package/doc/interfaces/SecurityGuide200ResponseData.md

@@ -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)