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

package/doc/interfaces/Report.md

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

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

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

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

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

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