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

package/doc/interfaces/TestResult.md

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

package/doc/interfaces/ValueDefinition.md

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

package/doc/interfaces/ValueDefinition200Response.md

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

package/doc/interfaces/ValueDefinition200ResponseData.md

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

package/doc/interfaces/ValueDefinitions200Response.md

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