@redhat-cloud-services/compliance-client 3.0.1 → 3.0.3

package/doc/interfaces/RuleGroup.md

@@ -0,0 +1,127 @@
+[@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

@@ -0,0 +1,27 @@
+[@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

@@ -0,0 +1,27 @@
+[@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

@@ -0,0 +1,57 @@
+[@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

@@ -0,0 +1,57 @@
+[@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

@@ -0,0 +1,127 @@
+[@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

@@ -0,0 +1,27 @@
+[@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

@@ -0,0 +1,27 @@
+[@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)

package/doc/interfaces/SecurityGuides200Response.md

@@ -0,0 +1,57 @@
+[@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)

package/doc/interfaces/SupportedProfile.md

@@ -0,0 +1,144 @@
+[@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)