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

package/doc/interfaces/Links.md

@@ -0,0 +1,80 @@
+[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / Links
+
+# Interface: Links
+
+**`Export`**
+
+Links
+
+## Table of contents
+
+### Properties
+
+- [first](Links.md#first)
+- [last](Links.md#last)
+- [next](Links.md#next)
+- [previous](Links.md#previous)
+
+## Properties
+
+### first
+
+• `Optional` **first**: `any`
+
+Link to first page
+
+**`Memberof`**
+
+Links
+
+#### Defined in
+
+[types/index.ts:64](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L64)
+
+___
+
+### last
+
+• `Optional` **last**: `any`
+
+Link to last page
+
+**`Memberof`**
+
+Links
+
+#### Defined in
+
+[types/index.ts:70](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L70)
+
+___
+
+### next
+
+• `Optional` **next**: `any`
+
+Link to next page
+
+**`Memberof`**
+
+Links
+
+#### Defined in
+
+[types/index.ts:82](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L82)
+
+___
+
+### previous
+
+• `Optional` **previous**: `any`
+
+Link to previous page
+
+**`Memberof`**
+
+Links
+
+#### Defined in
+
+[types/index.ts:76](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L76)

package/doc/interfaces/Metadata.md

@@ -0,0 +1,97 @@
+[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / Metadata
+
+# Interface: Metadata
+
+**`Export`**
+
+Metadata
+
+## Table of contents
+
+### Properties
+
+- [filter](Metadata.md#filter)
+- [limit](Metadata.md#limit)
+- [offset](Metadata.md#offset)
+- [sort\_by](Metadata.md#sort_by)
+- [total](Metadata.md#total)
+
+## Properties
+
+### filter
+
+• `Optional` **filter**: `any`
+
+Query string used to filter items by their attributes
+
+**`Memberof`**
+
+Metadata
+
+#### Defined in
+
+[types/index.ts:119](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L119)
+
+___
+
+### limit
+
+• `Optional` **limit**: `any`
+
+Number of items returned per page
+
+**`Memberof`**
+
+Metadata
+
+#### Defined in
+
+[types/index.ts:101](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L101)
+
+___
+
+### offset
+
+• `Optional` **offset**: `any`
+
+Offset of the first item of paginated response
+
+**`Memberof`**
+
+Metadata
+
+#### Defined in
+
+[types/index.ts:107](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L107)
+
+___
+
+### sort\_by
+
+• `Optional` **sort\_by**: `any`
+
+Attribute and direction the items are sorted by
+
+**`Memberof`**
+
+Metadata
+
+#### Defined in
+
+[types/index.ts:113](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L113)
+
+___
+
+### total
+
+• `Optional` **total**: `any`
+
+Total number of items
+
+**`Memberof`**
+
+Metadata
+
+#### Defined in
+
+[types/index.ts:95](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L95)

package/doc/interfaces/Policies200Response.md

@@ -0,0 +1,57 @@
+[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / Policies200Response
+
+# Interface: Policies200Response
+
+**`Export`**
+
+Policies200Response
+
+## Table of contents
+
+### Properties
+
+- [data](Policies200Response.md#data)
+- [links](Policies200Response.md#links)
+- [meta](Policies200Response.md#meta)
+
+## Properties
+
+### data
+
+• `Optional` **data**: `any`
+
+**`Memberof`**
+
+Policies200Response
+
+#### Defined in
+
+[types/index.ts:144](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L144)
+
+___
+
+### links
+
+• `Optional` **links**: [`Links`](Links.md)
+
+**`Memberof`**
+
+Policies200Response
+
+#### Defined in
+
+[types/index.ts:138](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L138)
+
+___
+
+### meta
+
+• `Optional` **meta**: [`Metadata`](Metadata.md)
+
+**`Memberof`**
+
+Policies200Response
+
+#### Defined in
+
+[types/index.ts:132](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L132)

package/doc/interfaces/Policy.md

@@ -0,0 +1,195 @@
+[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / Policy
+
+# Interface: Policy
+
+**`Export`**
+
+Policy
+
+## Table of contents
+
+### Properties
+
+- [business\_objective](Policy.md#business_objective)
+- [compliance\_threshold](Policy.md#compliance_threshold)
+- [description](Policy.md#description)
+- [id](Policy.md#id)
+- [os\_major\_version](Policy.md#os_major_version)
+- [profile\_id](Policy.md#profile_id)
+- [profile\_title](Policy.md#profile_title)
+- [ref\_id](Policy.md#ref_id)
+- [title](Policy.md#title)
+- [total\_system\_count](Policy.md#total_system_count)
+- [type](Policy.md#type)
+
+## Properties
+
+### business\_objective
+
+• `Optional` **business\_objective**: `any`
+
+The Business Objective associated to the Policy
+
+**`Memberof`**
+
+Policy
+
+#### Defined in
+
+[types/index.ts:181](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L181)
+
+___
+
+### compliance\_threshold
+
+• **compliance\_threshold**: `any`
+
+The percentage above which the Policy meets compliance requirements
+
+**`Memberof`**
+
+Policy
+
+#### Defined in
+
+[types/index.ts:187](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L187)
+
+___
+
+### description
+
+• `Optional` **description**: `any`
+
+Longer description of the Policy
+
+**`Memberof`**
+
+Policy
+
+#### Defined in
+
+[types/index.ts:175](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L175)
+
+___
+
+### id
+
+• `Optional` **id**: `any`
+
+**`Memberof`**
+
+Policy
+
+#### Defined in
+
+[types/index.ts:157](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L157)
+
+___
+
+### os\_major\_version
+
+• `Optional` **os\_major\_version**: `any`
+
+Major version of the Operating System that the Policy covers
+
+**`Memberof`**
+
+Policy
+
+#### Defined in
+
+[types/index.ts:199](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L199)
+
+___
+
+### profile\_id
+
+• **profile\_id**: `any`
+
+Identifier of the underlying Profile
+
+**`Memberof`**
+
+Policy
+
+#### Defined in
+
+[types/index.ts:193](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L193)
+
+___
+
+### profile\_title
+
+• `Optional` **profile\_title**: `any`
+
+Title of the associated Policy
+
+**`Memberof`**
+
+Policy
+
+#### Defined in
+
+[types/index.ts:211](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L211)
+
+___
+
+### ref\_id
+
+• `Optional` **ref\_id**: `any`
+
+Identificator of the Profile
+
+**`Memberof`**
+
+Policy
+
+#### Defined in
+
+[types/index.ts:205](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L205)
+
+___
+
+### title
+
+• `Optional` **title**: `any`
+
+Short title of the Policy
+
+**`Memberof`**
+
+Policy
+
+#### Defined in
+
+[types/index.ts:169](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L169)
+
+___
+
+### total\_system\_count
+
+• `Optional` **total\_system\_count**: `any`
+
+The number of Systems assigned to this Policy
+
+**`Memberof`**
+
+Policy
+
+#### Defined in
+
+[types/index.ts:217](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L217)
+
+___
+
+### type
+
+• `Optional` **type**: ``"policy"``
+
+**`Memberof`**
+
+Policy
+
+#### Defined in
+
+[types/index.ts:163](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L163)

package/doc/interfaces/PolicyUpdate.md

@@ -0,0 +1,63 @@
+[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / PolicyUpdate
+
+# Interface: PolicyUpdate
+
+**`Export`**
+
+PolicyUpdate
+
+## Table of contents
+
+### Properties
+
+- [business\_objective](PolicyUpdate.md#business_objective)
+- [compliance\_threshold](PolicyUpdate.md#compliance_threshold)
+- [description](PolicyUpdate.md#description)
+
+## Properties
+
+### business\_objective
+
+• `Optional` **business\_objective**: `any`
+
+The Business Objective associated to the Policy
+
+**`Memberof`**
+
+PolicyUpdate
+
+#### Defined in
+
+[types/index.ts:243](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L243)
+
+___
+
+### compliance\_threshold
+
+• `Optional` **compliance\_threshold**: `any`
+
+The percentage above which the Policy meets compliance requirements
+
+**`Memberof`**
+
+PolicyUpdate
+
+#### Defined in
+
+[types/index.ts:249](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L249)
+
+___
+
+### description
+
+• `Optional` **description**: `any`
+
+Longer description of the Policy
+
+**`Memberof`**
+
+PolicyUpdate
+
+#### Defined in
+
+[types/index.ts:237](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L237)

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/RedHatInsights/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/RedHatInsights/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/RedHatInsights/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/RedHatInsights/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/RedHatInsights/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/RedHatInsights/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/RedHatInsights/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/RedHatInsights/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/RedHatInsights/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/RedHatInsights/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/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L338)