@redhat-cloud-services/compliance-client 0.1.0

package/doc/interfaces/Profile.md

@@ -0,0 +1,110 @@
+[@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/AsToNlele/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/AsToNlele/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/AsToNlele/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/AsToNlele/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/AsToNlele/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/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L292)

package/doc/interfaces/Profile200Response.md

@@ -0,0 +1,27 @@
+[@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/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L312)

package/doc/interfaces/Profile200ResponseData.md

@@ -0,0 +1,27 @@
+[@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/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L325)

package/doc/interfaces/Profiles200Response.md

@@ -0,0 +1,57 @@
+[@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/AsToNlele/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/AsToNlele/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/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L338)

package/doc/interfaces/Rule.md

@@ -0,0 +1,161 @@
+[@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:393](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L393)
+
+___
+
+### id
+
+• `Optional` **id**: `any`
+
+**`Memberof`**
+
+Rule
+
+#### Defined in
+
+[types/index.ts:363](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L363)
+
+___
+
+### precedence
+
+• `Optional` **precedence**: `any`
+
+The original sorting precedence of the Rule in the Security Guide
+
+**`Memberof`**
+
+Rule
+
+#### Defined in
+
+[types/index.ts:399](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L399)
+
+___
+
+### rationale
+
+• `Optional` **rationale**: `any`
+
+Rationale of the Rule
+
+**`Memberof`**
+
+Rule
+
+#### Defined in
+
+[types/index.ts:387](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L387)
+
+___
+
+### ref\_id
+
+• `Optional` **ref\_id**: `any`
+
+Identificator of the Rule
+
+**`Memberof`**
+
+Rule
+
+#### Defined in
+
+[types/index.ts:375](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L375)
+
+___
+
+### 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:411](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L411)
+
+___
+
+### severity
+
+• `Optional` **severity**: `any`
+
+The severity of the Rule
+
+**`Memberof`**
+
+Rule
+
+#### Defined in
+
+[types/index.ts:405](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L405)
+
+___
+
+### title
+
+• `Optional` **title**: `any`
+
+Short title of the Rule
+
+**`Memberof`**
+
+Rule
+
+#### Defined in
+
+[types/index.ts:381](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L381)
+
+___
+
+### type
+
+• `Optional` **type**: ``"rule"``
+
+**`Memberof`**
+
+Rule
+
+#### Defined in
+
+[types/index.ts:369](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L369)

package/doc/interfaces/Rule200Response.md

@@ -0,0 +1,27 @@
+[@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:431](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L431)

package/doc/interfaces/Rule200ResponseData.md

@@ -0,0 +1,27 @@
+[@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:444](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L444)

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:487](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L487)
+
+___
+
+### id
+
+• `Optional` **id**: `any`
+
+**`Memberof`**
+
+RuleGroup
+
+#### Defined in
+
+[types/index.ts:457](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L457)
+
+___
+
+### precedence
+
+• `Optional` **precedence**: `any`
+
+The original sorting precedence of the Rule Group in the Security Guide
+
+**`Memberof`**
+
+RuleGroup
+
+#### Defined in
+
+[types/index.ts:493](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L493)
+
+___
+
+### rationale
+
+• `Optional` **rationale**: `any`
+
+Rationale of the Rule Group
+
+**`Memberof`**
+
+RuleGroup
+
+#### Defined in
+
+[types/index.ts:481](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L481)
+
+___
+
+### ref\_id
+
+• `Optional` **ref\_id**: `any`
+
+Identificator of the Rule Group
+
+**`Memberof`**
+
+RuleGroup
+
+#### Defined in
+
+[types/index.ts:469](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L469)
+
+___
+
+### title
+
+• `Optional` **title**: `any`
+
+Short title of the Rule Group
+
+**`Memberof`**
+
+RuleGroup
+
+#### Defined in
+
+[types/index.ts:475](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L475)
+
+___
+
+### type
+
+• `Optional` **type**: ``"rule_group"``
+
+**`Memberof`**
+
+RuleGroup
+
+#### Defined in
+
+[types/index.ts:463](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L463)

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:513](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L513)

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:526](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L526)

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:551](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L551)
+
+___
+
+### links
+
+• `Optional` **links**: [`Links`](Links.md)
+
+**`Memberof`**
+
+RuleGroups200Response
+
+#### Defined in
+
+[types/index.ts:545](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L545)
+
+___
+
+### meta
+
+• `Optional` **meta**: [`Metadata`](Metadata.md)
+
+**`Memberof`**
+
+RuleGroups200Response
+
+#### Defined in
+
+[types/index.ts:539](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L539)