@redhat-cloud-services/compliance-client 3.0.7 → 4.0.0

package/dist/types/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../types/index.ts"],"names":[],"mappings":";;;AAqPa,QAAA,cAAc,GAAG;IAC1B,MAAM,EAAE,QAAQ;CACV,CAAC;AAyEE,QAAA,eAAe,GAAG;IAC3B,OAAO,EAAE,SAAS;CACZ,CAAC;AAmJE,QAAA,cAAc,GAAG;IAC1B,MAAM,EAAE,QAAQ;CACV,CAAC;AAyNE,QAAA,YAAY,GAAG;IACxB,IAAI,EAAE,MAAM;CACN,CAAC;AAgFE,QAAA,iBAAiB,GAAG;IAC7B,SAAS,EAAE,YAAY;CACjB,CAAC;AAgKE,QAAA,kBAAkB,GAAG;IAC9B,IAAI,EAAE,MAAM;CACN,CAAC;AAGE,QAAA,oBAAoB,GAAG;IAChC,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;IACd,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,aAAa,EAAE,eAAe;IAC9B,UAAU,EAAE,YAAY;IACxB,aAAa,EAAE,eAAe;IAC9B,WAAW,EAAE,aAAa;CACpB,CAAC;AA+EE,QAAA,qBAAqB,GAAG;IACjC,aAAa,EAAE,gBAAgB;CACzB,CAAC;AA4JE,QAAA,wBAAwB,GAAG;IACpC,gBAAgB,EAAE,mBAAmB;CAC/B,CAAC;AAyHE,QAAA,cAAc,GAAG;IAC1B,MAAM,EAAE,QAAQ;CACV,CAAC;AA+GE,QAAA,iBAAiB,GAAG;IAC7B,SAAS,EAAE,WAAW;CAChB,CAAC;AAoKE,QAAA,kBAAkB,GAAG;IAC9B,UAAU,EAAE,aAAa;CACnB,CAAC;AAsDE,QAAA,uBAAuB,GAAG;IACnC,eAAe,EAAE,kBAAkB;CAC7B,CAAC"}

package/doc/.nojekyll

@@ -1 +0,0 @@
-TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

package/doc/README.md

@@ -1,69 +0,0 @@
-@redhat-cloud-services/compliance-client / [Exports](modules.md)
-
-# Javascript client for the compliance API
-If you want to use [RedHatInsights/compliance](https://github.com/RedHatInsights/compliance) you shouldn't use get requests directly, but rather use this client to integrate with this service.
-
-## Install
-NPM
-```bash
-npm install --save @redhat-cloud-services/compliance-client
-```
-
-Or Yarn
-```bash
-yarn add @redhat-cloud-services/compliance-client
-```
-
-### Usage
-This client is using typescript and axios. Types are distributed with this package, so no need to define or install them separately.
-
-To correctly bootstrap this API you should use this config (no need to define it multiple times, just one config and reimport it anywhere you want to use it).
-```JS
-// api.js
-import axios from 'axios';
-import { Configuration } from '@redhat-cloud-services/compliance-client';
-const instance = axios.create();
-
-// BASE_PATH should be set in your constants file
-const configApi = new Configuration(undefined, BASE_PATH, instance);
-export configApi;
-```
-
-If you want to add some interceptors you can use axios build in interceptors
-```JS
-// api.js
-import axios from 'axios';
-import { Configuration } from '@redhat-cloud-services/compliance-client';
-const instance = axios.create();
-
-// Request interceptor
-instance.interceptors.request.use((request) => {
-    // some logic to do with request
-});
-
-// Response interceptor
-instance.interceptors.response.use((response) => {
-    // some logic to do with request
-});
-
-// Error interceptor
-instance.interceptors.response.use(null, (error) => {
-    // some logic to do with error
-});
-
-// BASE_PATH should be set in your constants file
-const configApi = new Configuration(undefined, BASE_PATH, instance);
-export configApi;
-```
-
-## Building
-
-Run `nx build @redhat-cloud-services/compliance-client` to build the library.
-
-## Running unit tests
-
-Run `nx test @redhat-cloud-services/compliance-client` to execute the unit tests via [Jest](https://jestjs.io).
-
-## API documentation
-
-* [README](doc/README.md)

package/doc/interfaces/AssignRulesRequest.md

@@ -1,27 +0,0 @@
-[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / AssignRulesRequest
-
-# Interface: AssignRulesRequest
-
-**`Export`**
-
-AssignRulesRequest
-
-## Table of contents
-
-### Properties
-
-- [ids](AssignRulesRequest.md#ids)
-
-## Properties
-
-### ids
-
-• `Optional` **ids**: `any`
-
-**`Memberof`**
-
-AssignRulesRequest
-
-#### Defined in
-
-[types/index.ts:12](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L12)

package/doc/interfaces/CreatePolicy201Response.md

@@ -1,27 +0,0 @@
-[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / CreatePolicy201Response
-
-# Interface: CreatePolicy201Response
-
-**`Export`**
-
-CreatePolicy201Response
-
-## Table of contents
-
-### Properties
-
-- [data](CreatePolicy201Response.md#data)
-
-## Properties
-
-### data
-
-• `Optional` **data**: [`CreatePolicy201ResponseData`](CreatePolicy201ResponseData.md)
-
-**`Memberof`**
-
-CreatePolicy201Response
-
-#### Defined in
-
-[types/index.ts:25](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L25)

package/doc/interfaces/CreatePolicy201ResponseData.md

@@ -1,27 +0,0 @@
-[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / CreatePolicy201ResponseData
-
-# Interface: CreatePolicy201ResponseData
-
-**`Export`**
-
-CreatePolicy201ResponseData
-
-## Table of contents
-
-### Properties
-
-- [schema](CreatePolicy201ResponseData.md#schema)
-
-## Properties
-
-### schema
-
-• `Optional` **schema**: [`Policy`](Policy.md)
-
-**`Memberof`**
-
-CreatePolicy201ResponseData
-
-#### Defined in
-
-[types/index.ts:38](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L38)

package/doc/interfaces/Errors.md

@@ -1,27 +0,0 @@
-[@redhat-cloud-services/compliance-client](../README.md) / [Exports](../modules.md) / Errors
-
-# Interface: Errors
-
-**`Export`**
-
-Errors
-
-## Table of contents
-
-### Properties
-
-- [errors](Errors.md#errors)
-
-## Properties
-
-### errors
-
-• **errors**: `any`
-
-**`Memberof`**
-
-Errors
-
-#### Defined in
-
-[types/index.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/compliance/types/index.ts#L51)

package/doc/interfaces/Links.md

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

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

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

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

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