@redhat-cloud-services/compliance-client 0.1.6 → 0.2.0

package/doc/interfaces/Report.md

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

package/doc/interfaces/Report200Response.md

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

package/doc/interfaces/Report200ResponseData.md

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

package/doc/interfaces/ReportTestResults200Response.md

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

package/doc/interfaces/Reports200Response.md

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

package/doc/interfaces/Rule.md

@@ -34,7 +34,7 @@ Rule
 
 #### Defined in
 
-[types/index.ts:393](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L393)
+[types/index.ts:561](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L561)
 
 ___
 
@@ -48,7 +48,7 @@ Rule
 
 #### Defined in
 
-[types/index.ts:363](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L363)
+[types/index.ts:531](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L531)
 
 ___
 
@@ -64,7 +64,7 @@ Rule
 
 #### Defined in
 
-[types/index.ts:399](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L399)
+[types/index.ts:567](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L567)
 
 ___
 
@@ -80,7 +80,7 @@ Rule
 
 #### Defined in
 
-[types/index.ts:387](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L387)
+[types/index.ts:555](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L555)
 
 ___
 
@@ -96,7 +96,7 @@ Rule
 
 #### Defined in
 
-[types/index.ts:375](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L375)
+[types/index.ts:543](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L543)
 
 ___
 
@@ -112,7 +112,7 @@ Rule
 
 #### Defined in
 
-[types/index.ts:411](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L411)
+[types/index.ts:579](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L579)
 
 ___
 
@@ -128,7 +128,7 @@ Rule
 
 #### Defined in
 
-[types/index.ts:405](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L405)
+[types/index.ts:573](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L573)
 
 ___
 
@@ -144,7 +144,7 @@ Rule
 
 #### Defined in
 
-[types/index.ts:381](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L381)
+[types/index.ts:549](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L549)
 
 ___
 
@@ -158,4 +158,4 @@ Rule
 
 #### Defined in
 
-[types/index.ts:369](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L369)
+[types/index.ts:537](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L537)

package/doc/interfaces/Rule200Response.md

@@ -24,4 +24,4 @@ Rule200Response
 
 #### Defined in
 
-[types/index.ts:431](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L431)
+[types/index.ts:599](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L599)

package/doc/interfaces/Rule200ResponseData.md

@@ -24,4 +24,4 @@ Rule200ResponseData
 
 #### Defined in
 
-[types/index.ts:444](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L444)
+[types/index.ts:612](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L612)

package/doc/interfaces/RuleGroup.md

@@ -32,7 +32,7 @@ RuleGroup
 
 #### Defined in
 
-[types/index.ts:487](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L487)
+[types/index.ts:655](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L655)
 
 ___
 
@@ -46,7 +46,7 @@ RuleGroup
 
 #### Defined in
 
-[types/index.ts:457](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L457)
+[types/index.ts:625](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L625)
 
 ___
 
@@ -62,7 +62,7 @@ RuleGroup
 
 #### Defined in
 
-[types/index.ts:493](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L493)
+[types/index.ts:661](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L661)
 
 ___
 
@@ -78,7 +78,7 @@ RuleGroup
 
 #### Defined in
 
-[types/index.ts:481](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L481)
+[types/index.ts:649](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L649)
 
 ___
 
@@ -94,7 +94,7 @@ RuleGroup
 
 #### Defined in
 
-[types/index.ts:469](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L469)
+[types/index.ts:637](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L637)
 
 ___
 
@@ -110,7 +110,7 @@ RuleGroup
 
 #### Defined in
 
-[types/index.ts:475](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L475)
+[types/index.ts:643](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L643)
 
 ___
 
@@ -124,4 +124,4 @@ RuleGroup
 
 #### Defined in
 
-[types/index.ts:463](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L463)
+[types/index.ts:631](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L631)

package/doc/interfaces/RuleGroup200Response.md

@@ -24,4 +24,4 @@ RuleGroup200Response
 
 #### Defined in
 
-[types/index.ts:513](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L513)
+[types/index.ts:681](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L681)

package/doc/interfaces/RuleGroup200ResponseData.md

@@ -24,4 +24,4 @@ RuleGroup200ResponseData
 
 #### Defined in
 
-[types/index.ts:526](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L526)
+[types/index.ts:694](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L694)

package/doc/interfaces/RuleGroups200Response.md

@@ -26,7 +26,7 @@ RuleGroups200Response
 
 #### Defined in
 
-[types/index.ts:551](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L551)
+[types/index.ts:719](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L719)
 
 ___
 
@@ -40,7 +40,7 @@ RuleGroups200Response
 
 #### Defined in
 
-[types/index.ts:545](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L545)
+[types/index.ts:713](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L713)
 
 ___
 
@@ -54,4 +54,4 @@ RuleGroups200Response
 
 #### Defined in
 
-[types/index.ts:539](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L539)
+[types/index.ts:707](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L707)

package/doc/interfaces/Rules200Response.md

@@ -26,7 +26,7 @@ Rules200Response
 
 #### Defined in
 
-[types/index.ts:576](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L576)
+[types/index.ts:744](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L744)
 
 ___
 
@@ -40,7 +40,7 @@ Rules200Response
 
 #### Defined in
 
-[types/index.ts:570](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L570)
+[types/index.ts:738](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L738)
 
 ___
 
@@ -54,4 +54,4 @@ Rules200Response
 
 #### Defined in
 
-[types/index.ts:564](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L564)
+[types/index.ts:732](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L732)

package/doc/interfaces/SecurityGuide.md

@@ -32,7 +32,7 @@ SecurityGuide
 
 #### Defined in
 
-[types/index.ts:619](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L619)
+[types/index.ts:787](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L787)
 
 ___
 
@@ -46,7 +46,7 @@ SecurityGuide
 
 #### Defined in
 
-[types/index.ts:589](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L589)
+[types/index.ts:757](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L757)
 
 ___
 
@@ -62,7 +62,7 @@ SecurityGuide
 
 #### Defined in
 
-[types/index.ts:625](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L625)
+[types/index.ts:793](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L793)
 
 ___
 
@@ -78,7 +78,7 @@ SecurityGuide
 
 #### Defined in
 
-[types/index.ts:601](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L601)
+[types/index.ts:769](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L769)
 
 ___
 
@@ -94,7 +94,7 @@ SecurityGuide
 
 #### Defined in
 
-[types/index.ts:607](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L607)
+[types/index.ts:775](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L775)
 
 ___
 
@@ -108,7 +108,7 @@ SecurityGuide
 
 #### Defined in
 
-[types/index.ts:595](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L595)
+[types/index.ts:763](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L763)
 
 ___
 
@@ -124,4 +124,4 @@ SecurityGuide
 
 #### Defined in
 
-[types/index.ts:613](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L613)
+[types/index.ts:781](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L781)

package/doc/interfaces/SecurityGuide200Response.md

@@ -24,4 +24,4 @@ SecurityGuide200Response
 
 #### Defined in
 
-[types/index.ts:645](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L645)
+[types/index.ts:813](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L813)

package/doc/interfaces/SecurityGuide200ResponseData.md

@@ -24,4 +24,4 @@ SecurityGuide200ResponseData
 
 #### Defined in
 
-[types/index.ts:658](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L658)
+[types/index.ts:826](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L826)