@redhat-cloud-services/compliance-client 0.1.0

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:576](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L576)
+
+___
+
+### links
+
+• `Optional` **links**: [`Links`](Links.md)
+
+**`Memberof`**
+
+Rules200Response
+
+#### Defined in
+
+[types/index.ts:570](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L570)
+
+___
+
+### meta
+
+• `Optional` **meta**: [`Metadata`](Metadata.md)
+
+**`Memberof`**
+
+Rules200Response
+
+#### Defined in
+
+[types/index.ts:564](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L564)

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:619](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L619)
+
+___
+
+### id
+
+• `Optional` **id**: `any`
+
+**`Memberof`**
+
+SecurityGuide
+
+#### Defined in
+
+[types/index.ts:589](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L589)
+
+___
+
+### 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:625](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L625)
+
+___
+
+### ref\_id
+
+• `Optional` **ref\_id**: `any`
+
+Identificator of the Security Guide
+
+**`Memberof`**
+
+SecurityGuide
+
+#### Defined in
+
+[types/index.ts:601](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L601)
+
+___
+
+### title
+
+• `Optional` **title**: `any`
+
+Short title of the Security Guide
+
+**`Memberof`**
+
+SecurityGuide
+
+#### Defined in
+
+[types/index.ts:607](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L607)
+
+___
+
+### type
+
+• `Optional` **type**: ``"security_guide"``
+
+**`Memberof`**
+
+SecurityGuide
+
+#### Defined in
+
+[types/index.ts:595](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L595)
+
+___
+
+### version
+
+• `Optional` **version**: `any`
+
+Version of the Security Guide
+
+**`Memberof`**
+
+SecurityGuide
+
+#### Defined in
+
+[types/index.ts:613](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L613)

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

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

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:683](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L683)
+
+___
+
+### links
+
+• `Optional` **links**: [`Links`](Links.md)
+
+**`Memberof`**
+
+SecurityGuides200Response
+
+#### Defined in
+
+[types/index.ts:677](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L677)
+
+___
+
+### meta
+
+• `Optional` **meta**: [`Metadata`](Metadata.md)
+
+**`Memberof`**
+
+SecurityGuides200Response
+
+#### Defined in
+
+[types/index.ts:671](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L671)

package/doc/interfaces/SupportedProfile.md

@@ -0,0 +1,127 @@
+[@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\_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:696](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L696)
+
+___
+
+### 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:726](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L726)
+
+___
+
+### 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:732](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L732)
+
+___
+
+### ref\_id
+
+• `Optional` **ref\_id**: `any`
+
+Identificator of the Profile
+
+**`Memberof`**
+
+SupportedProfile
+
+#### Defined in
+
+[types/index.ts:708](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L708)
+
+___
+
+### security\_guide\_version
+
+• `Optional` **security\_guide\_version**: `any`
+
+Version of the latest Security Guide supporting this Profile
+
+**`Memberof`**
+
+SupportedProfile
+
+#### Defined in
+
+[types/index.ts:720](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L720)
+
+___
+
+### title
+
+• `Optional` **title**: `any`
+
+Short title of the Profile
+
+**`Memberof`**
+
+SupportedProfile
+
+#### Defined in
+
+[types/index.ts:714](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L714)
+
+___
+
+### type
+
+• `Optional` **type**: ``"supported_profile"``
+
+**`Memberof`**
+
+SupportedProfile
+
+#### Defined in
+
+[types/index.ts:702](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L702)

package/doc/interfaces/SupportedProfiles200Response.md

@@ -0,0 +1,57 @@
+[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / SupportedProfiles200Response
+
+# Interface: SupportedProfiles200Response
+
+**`Export`**
+
+SupportedProfiles200Response
+
+## Table of contents
+
+### Properties
+
+- [data](SupportedProfiles200Response.md#data)
+- [links](SupportedProfiles200Response.md#links)
+- [meta](SupportedProfiles200Response.md#meta)
+
+## Properties
+
+### data
+
+• `Optional` **data**: `any`
+
+**`Memberof`**
+
+SupportedProfiles200Response
+
+#### Defined in
+
+[types/index.ts:764](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L764)
+
+___
+
+### links
+
+• `Optional` **links**: [`Links`](Links.md)
+
+**`Memberof`**
+
+SupportedProfiles200Response
+
+#### Defined in
+
+[types/index.ts:758](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L758)
+
+___
+
+### meta
+
+• `Optional` **meta**: [`Metadata`](Metadata.md)
+
+**`Memberof`**
+
+SupportedProfiles200Response
+
+#### Defined in
+
+[types/index.ts:752](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L752)

package/doc/interfaces/System.md

@@ -0,0 +1,215 @@
+[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / System
+
+# Interface: System
+
+**`Export`**
+
+System
+
+## Table of contents
+
+### Properties
+
+- [culled\_timestamp](System.md#culled_timestamp)
+- [display\_name](System.md#display_name)
+- [groups](System.md#groups)
+- [id](System.md#id)
+- [insights\_id](System.md#insights_id)
+- [os\_major\_version](System.md#os_major_version)
+- [os\_minor\_version](System.md#os_minor_version)
+- [policies](System.md#policies)
+- [stale\_timestamp](System.md#stale_timestamp)
+- [stale\_warning\_timestamp](System.md#stale_warning_timestamp)
+- [tags](System.md#tags)
+- [type](System.md#type)
+- [updated](System.md#updated)
+
+## Properties
+
+### culled\_timestamp
+
+• `Optional` **culled\_timestamp**: `any`
+
+**`Memberof`**
+
+System
+
+#### Defined in
+
+[types/index.ts:801](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L801)
+
+___
+
+### display\_name
+
+• `Optional` **display\_name**: `any`
+
+Display Name of the System
+
+**`Memberof`**
+
+System
+
+#### Defined in
+
+[types/index.ts:789](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L789)
+
+___
+
+### groups
+
+• `Optional` **groups**: `any`
+
+**`Memberof`**
+
+System
+
+#### Defined in
+
+[types/index.ts:795](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L795)
+
+___
+
+### id
+
+• `Optional` **id**: `any`
+
+**`Memberof`**
+
+System
+
+#### Defined in
+
+[types/index.ts:777](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L777)
+
+___
+
+### insights\_id
+
+• `Optional` **insights\_id**: `any`
+
+**`Memberof`**
+
+System
+
+#### Defined in
+
+[types/index.ts:825](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L825)
+
+___
+
+### os\_major\_version
+
+• `Optional` **os\_major\_version**: `any`
+
+Major version of the Operating System
+
+**`Memberof`**
+
+System
+
+#### Defined in
+
+[types/index.ts:837](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L837)
+
+___
+
+### os\_minor\_version
+
+• `Optional` **os\_minor\_version**: `any`
+
+Minor version of the Operating System
+
+**`Memberof`**
+
+System
+
+#### Defined in
+
+[types/index.ts:843](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L843)
+
+___
+
+### policies
+
+• `Optional` **policies**: `any`
+
+List of Policies assigned to the System, visible only when not listing Systems under a given Policy
+
+**`Memberof`**
+
+System
+
+#### Defined in
+
+[types/index.ts:849](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L849)
+
+___
+
+### stale\_timestamp
+
+• `Optional` **stale\_timestamp**: `any`
+
+**`Memberof`**
+
+System
+
+#### Defined in
+
+[types/index.ts:807](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L807)
+
+___
+
+### stale\_warning\_timestamp
+
+• `Optional` **stale\_warning\_timestamp**: `any`
+
+**`Memberof`**
+
+System
+
+#### Defined in
+
+[types/index.ts:813](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L813)
+
+___
+
+### tags
+
+• `Optional` **tags**: `any`
+
+**`Memberof`**
+
+System
+
+#### Defined in
+
+[types/index.ts:831](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L831)
+
+___
+
+### type
+
+• `Optional` **type**: ``"system"``
+
+**`Memberof`**
+
+System
+
+#### Defined in
+
+[types/index.ts:783](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L783)
+
+___
+
+### updated
+
+• `Optional` **updated**: `any`
+
+**`Memberof`**
+
+System
+
+#### Defined in
+
+[types/index.ts:819](https://github.com/AsToNlele/javascript-clients/blob/main/packages/compliance/types/index.ts#L819)