diff --git a/packages/remediations/custom.d.ts b/packages/remediations/custom.d.ts deleted file mode 100644 index 32534cb16..000000000 --- a/packages/remediations/custom.d.ts +++ /dev/null @@ -1 +0,0 @@ -declare module 'url'; \ No newline at end of file diff --git a/packages/remediations/doc/.nojekyll b/packages/remediations/doc/.nojekyll deleted file mode 100644 index e2ac6616a..000000000 --- a/packages/remediations/doc/.nojekyll +++ /dev/null @@ -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. \ No newline at end of file diff --git a/packages/remediations/doc/README.md b/packages/remediations/doc/README.md deleted file mode 100644 index 49463d19b..000000000 --- a/packages/remediations/doc/README.md +++ /dev/null @@ -1,44 +0,0 @@ -@redhat-cloud-services/remediations-client / [Exports](modules.md) - -Javascript client for Remediations API -======================================= - -This is a client library for [RedHatInsights/insights-remediations](https://github.com/RedHatInsights/insights-remediations). - -Install -------- - -NPM - -```bash -npm install --save @redhat-cloud-services/remediations-client -``` - -Or Yarn - -```bash -yarn add @redhat-cloud-services/remediations-client -``` - -### Usage - -This client is using typescript and axios. Types are distributed with this package, so no need to define or install them separately. - -```js -import { RemediationsApi } from '@redhat-cloud-services/remediations-client'; - -const api = new RemediationsApi(); -const remediations = await api.getRemediations(); -``` - -## Building - -Run `nx build @redhat-cloud-services/remediations-client` to build the library. - -## Running unit tests - -Run `nx test @redhat-cloud-services/remediations-client` to execute the unit tests via [Jest](https://jestjs.io). - -## API documentation - -* [README](doc/README.md) diff --git a/packages/remediations/doc/classes/Configuration.md b/packages/remediations/doc/classes/Configuration.md deleted file mode 100644 index 4762dce6a..000000000 --- a/packages/remediations/doc/classes/Configuration.md +++ /dev/null @@ -1,146 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / Configuration - -# Class: Configuration - -## Table of contents - -### Constructors - -- [constructor](Configuration.md#constructor) - -### Properties - -- [accessToken](Configuration.md#accesstoken) -- [apiKey](Configuration.md#apikey) -- [baseOptions](Configuration.md#baseoptions) -- [basePath](Configuration.md#basepath) -- [password](Configuration.md#password) -- [username](Configuration.md#username) - -## Constructors - -### constructor - -• **new Configuration**(`param?`): [`Configuration`](Configuration.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `param` | [`ConfigurationParameters`](../interfaces/ConfigurationParameters.md) | - -#### Returns - -[`Configuration`](Configuration.md) - -#### Defined in - -[configuration.ts:67](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/configuration.ts#L67) - -## Properties - -### accessToken - -• `Optional` **accessToken**: `string` \| (`name?`: `string`, `scopes?`: `string`[]) => `string` - -parameter for oauth2 security - -**`Param`** - -security name - -**`Param`** - -oauth2 scope - -**`Memberof`** - -Configuration - -#### Defined in - -[configuration.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/configuration.ts#L51) - -___ - -### apiKey - -• `Optional` **apiKey**: `string` \| `Promise`\<`string`\> \| (`name`: `string`) => `string` \| (`name`: `string`) => `Promise`\<`string`\> - -parameter for apiKey security - -**`Param`** - -security name - -**`Memberof`** - -Configuration - -#### Defined in - -[configuration.ts:30](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/configuration.ts#L30) - -___ - -### baseOptions - -• `Optional` **baseOptions**: `any` - -base options for axios calls - -**`Memberof`** - -Configuration - -#### Defined in - -[configuration.ts:65](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/configuration.ts#L65) - -___ - -### basePath - -• `Optional` **basePath**: `string` - -override base path - -**`Memberof`** - -Configuration - -#### Defined in - -[configuration.ts:58](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/configuration.ts#L58) - -___ - -### password - -• `Optional` **password**: `string` - -parameter for basic security - -**`Memberof`** - -Configuration - -#### Defined in - -[configuration.ts:44](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/configuration.ts#L44) - -___ - -### username - -• `Optional` **username**: `string` - -parameter for basic security - -**`Memberof`** - -Configuration - -#### Defined in - -[configuration.ts:37](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/configuration.ts#L37) diff --git a/packages/remediations/doc/classes/DiagnosisApi.md b/packages/remediations/doc/classes/DiagnosisApi.md deleted file mode 100644 index 207426b9e..000000000 --- a/packages/remediations/doc/classes/DiagnosisApi.md +++ /dev/null @@ -1,134 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / DiagnosisApi - -# Class: DiagnosisApi - -DiagnosisApi - object-oriented interface - -**`Export`** - -DiagnosisApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`DiagnosisApi`** - -## Table of contents - -### Constructors - -- [constructor](DiagnosisApi.md#constructor) - -### Properties - -- [axios](DiagnosisApi.md#axios) -- [basePath](DiagnosisApi.md#basepath) -- [configuration](DiagnosisApi.md#configuration) - -### Methods - -- [getDiagnosis](DiagnosisApi.md#getdiagnosis) - -## Constructors - -### constructor - -• **new DiagnosisApi**(`configuration?`, `basePath?`, `axios?`): [`DiagnosisApi`](DiagnosisApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`DiagnosisApi`](DiagnosisApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/base.ts#L49) - -## Methods - -### getDiagnosis - -▸ **getDiagnosis**(`system`, `remediation?`, `branchId?`, `options?`): `Promise`\<`AxiosResponse`\<[`Diagnosis`](../interfaces/Diagnosis.md), `any`\>\> - -Provides host-specific diagnosis information - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `system` | `string` | System identifier | -| `remediation?` | `string` | Remediation identifier (uuid) | -| `branchId?` | `string` | Branch ID passed by satellite | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`Diagnosis`](../interfaces/Diagnosis.md), `any`\>\> - -**`Summary`** - -host-specific diagnosis - -**`Throws`** - -**`Memberof`** - -DiagnosisApi - -#### Defined in - -[api.ts:1430](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1430) diff --git a/packages/remediations/doc/classes/GeneratorApi.md b/packages/remediations/doc/classes/GeneratorApi.md deleted file mode 100644 index 28c85ecb9..000000000 --- a/packages/remediations/doc/classes/GeneratorApi.md +++ /dev/null @@ -1,132 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / GeneratorApi - -# Class: GeneratorApi - -GeneratorApi - object-oriented interface - -**`Export`** - -GeneratorApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`GeneratorApi`** - -## Table of contents - -### Constructors - -- [constructor](GeneratorApi.md#constructor) - -### Properties - -- [axios](GeneratorApi.md#axios) -- [basePath](GeneratorApi.md#basepath) -- [configuration](GeneratorApi.md#configuration) - -### Methods - -- [generate](GeneratorApi.md#generate) - -## Constructors - -### constructor - -• **new GeneratorApi**(`configuration?`, `basePath?`, `axios?`): [`GeneratorApi`](GeneratorApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`GeneratorApi`](GeneratorApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/base.ts#L49) - -## Methods - -### generate - -▸ **generate**(`playbookDefinition`, `options?`): `Promise`\<`AxiosResponse`\<`string`, `any`\>\> - -Generates an Ansible Playbook based on input parameters - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `playbookDefinition` | [`PlaybookDefinition`](../interfaces/PlaybookDefinition.md) | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`string`, `any`\>\> - -**`Summary`** - -Generate an Ansible Playbook - -**`Throws`** - -**`Memberof`** - -GeneratorApi - -#### Defined in - -[api.ts:1542](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1542) diff --git a/packages/remediations/doc/classes/RemediationsApi.md b/packages/remediations/doc/classes/RemediationsApi.md deleted file mode 100644 index 2c6453494..000000000 --- a/packages/remediations/doc/classes/RemediationsApi.md +++ /dev/null @@ -1,848 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / RemediationsApi - -# Class: RemediationsApi - -RemediationsApi - object-oriented interface - -**`Export`** - -RemediationsApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`RemediationsApi`** - -## Table of contents - -### Constructors - -- [constructor](RemediationsApi.md#constructor) - -### Properties - -- [axios](RemediationsApi.md#axios) -- [basePath](RemediationsApi.md#basepath) -- [configuration](RemediationsApi.md#configuration) - -### Methods - -- [bulkGetRemediationPlaybook](RemediationsApi.md#bulkgetremediationplaybook) -- [cancelPlaybookRuns](RemediationsApi.md#cancelplaybookruns) -- [checkExecutable](RemediationsApi.md#checkexecutable) -- [createRemediation](RemediationsApi.md#createremediation) -- [deleteRemediation](RemediationsApi.md#deleteremediation) -- [deleteRemediationIssue](RemediationsApi.md#deleteremediationissue) -- [deleteRemediationIssueSystem](RemediationsApi.md#deleteremediationissuesystem) -- [deleteRemediations](RemediationsApi.md#deleteremediations) -- [downloadPlaybooks](RemediationsApi.md#downloadplaybooks) -- [getPlaybookRunDetails](RemediationsApi.md#getplaybookrundetails) -- [getPlaybookRunSystemDetails](RemediationsApi.md#getplaybookrunsystemdetails) -- [getPlaybookRunSystems](RemediationsApi.md#getplaybookrunsystems) -- [getRemediation](RemediationsApi.md#getremediation) -- [getRemediationConnectionStatus](RemediationsApi.md#getremediationconnectionstatus) -- [getRemediationIssueSystems](RemediationsApi.md#getremediationissuesystems) -- [getRemediationPlaybook](RemediationsApi.md#getremediationplaybook) -- [getRemediations](RemediationsApi.md#getremediations) -- [listPlaybookRuns](RemediationsApi.md#listplaybookruns) -- [runRemediation](RemediationsApi.md#runremediation) -- [updateRemediation](RemediationsApi.md#updateremediation) -- [updateRemediationIssue](RemediationsApi.md#updateremediationissue) - -## Constructors - -### constructor - -• **new RemediationsApi**(`configuration?`, `basePath?`, `axios?`): [`RemediationsApi`](RemediationsApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`RemediationsApi`](RemediationsApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/base.ts#L49) - -## Methods - -### bulkGetRemediationPlaybook - -▸ **bulkGetRemediationPlaybook**(`id`, `requestBody`, `satOrg?`, `localhost?`, `options?`): `Promise`\<`AxiosResponse`\<`string`, `any`\>\> - -Fetch Ansible Playbook - for use with large list of target systems, RBAC permission {remediations:remediation:read} - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Remediation identifier | -| `requestBody` | `string`[] | Array of system inventory identifiers. | -| `satOrg?` | `string` | Organization ID passed by satellite | -| `localhost?` | `boolean` | Flag for localhost playbook generation | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`string`, `any`\>\> - -**`Summary`** - -Fetch Remediation Plan Playbook - -**`Throws`** - -**`Memberof`** - -RemediationsApi - -#### Defined in - -[api.ts:3132](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3132) - -___ - -### cancelPlaybookRuns - -▸ **cancelPlaybookRuns**(`id`, `playbookRunId`, `options?`): `Promise`\<`AxiosResponse`\<`object`, `any`\>\> - -Cancel execution of the remediation - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Remediation identifier | -| `playbookRunId` | `string` | Playbook run identifier (UUID) | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`object`, `any`\>\> - -**`Summary`** - -Cancel execution of the remediation - -**`Throws`** - -**`Memberof`** - -RemediationsApi - -#### Defined in - -[api.ts:3145](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3145) - -___ - -### checkExecutable - -▸ **checkExecutable**(`id`, `options?`): `Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -Checks remediation for the existence of smart_managment flaged systems - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Remediation identifier | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -**`Summary`** - -Check smart_managment systems - -**`Throws`** - -**`Memberof`** - -RemediationsApi - -#### Defined in - -[api.ts:3157](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3157) - -___ - -### createRemediation - -▸ **createRemediation**(`remediationInput`, `options?`): `Promise`\<`AxiosResponse`\<[`RemediationCreated`](../interfaces/RemediationCreated.md), `any`\>\> - -Creates a new Remediation based on given information, RBAC permission {remediations:remediation:write} - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `remediationInput` | [`RemediationInput`](../interfaces/RemediationInput.md) | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`RemediationCreated`](../interfaces/RemediationCreated.md), `any`\>\> - -**`Summary`** - -Create Remediation - -**`Throws`** - -**`Memberof`** - -RemediationsApi - -#### Defined in - -[api.ts:3169](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3169) - -___ - -### deleteRemediation - -▸ **deleteRemediation**(`id`, `options?`): `Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -Removes the given Remediation, RBAC permission {remediations:remediation:write} - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Remediation identifier | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -**`Summary`** - -Remove Remediation - -**`Throws`** - -**`Memberof`** - -RemediationsApi - -#### Defined in - -[api.ts:3181](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3181) - -___ - -### deleteRemediationIssue - -▸ **deleteRemediationIssue**(`id`, `issue`, `options?`): `Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -Removes the given Issue from the Remediation, RBAC permission {remediations:remediation:write} - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Remediation identifier | -| `issue` | `string` | Issue identifier (e.g. `advisor:CVE_2017_6074_kernel\|KERNEL_CVE_2017_6074`) | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -**`Summary`** - -Remove Remediation Issue - -**`Throws`** - -**`Memberof`** - -RemediationsApi - -#### Defined in - -[api.ts:3194](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3194) - -___ - -### deleteRemediationIssueSystem - -▸ **deleteRemediationIssueSystem**(`id`, `issue`, `system`, `options?`): `Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -Removes the given System from the Issue Remediation, RBAC permission {remediations:remediation:write} - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Remediation identifier | -| `issue` | `string` | Issue identifier (e.g. `advisor:CVE_2017_6074_kernel\|KERNEL_CVE_2017_6074`) | -| `system` | `string` | System identifier | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -**`Summary`** - -Remove Remediation Issue System - -**`Throws`** - -**`Memberof`** - -RemediationsApi - -#### Defined in - -[api.ts:3208](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3208) - -___ - -### deleteRemediations - -▸ **deleteRemediations**(`remediationsList`, `options?`): `Promise`\<`AxiosResponse`\<[`MultipleDelete`](../interfaces/MultipleDelete.md), `any`\>\> - -Removes the given list of Remediations. Requests containing malformed remediation IDs are rejected. Duplicate or missing IDs are ignored. RBAC permission {remediations:remediation:write} - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `remediationsList` | [`RemediationsList`](../interfaces/RemediationsList.md) | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`MultipleDelete`](../interfaces/MultipleDelete.md), `any`\>\> - -**`Summary`** - -Bulk Delete Remediations - -**`Throws`** - -**`Memberof`** - -RemediationsApi - -#### Defined in - -[api.ts:3220](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3220) - -___ - -### downloadPlaybooks - -▸ **downloadPlaybooks**(`selectedRemediations?`, `options?`): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> - -Downloads a zip file containing selected Remediations, RBAC permission {remediations:remediation:read} - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `selectedRemediations?` | `string`[] | Selected Remediations for download | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`any`, `any`\>\> - -**`Summary`** - -Download Remediations - -**`Throws`** - -**`Memberof`** - -RemediationsApi - -#### Defined in - -[api.ts:3232](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3232) - -___ - -### getPlaybookRunDetails - -▸ **getPlaybookRunDetails**(`id`, `playbookRunId`, `options?`): `Promise`\<`AxiosResponse`\<[`PlaybookRunExecutorDetails`](../interfaces/PlaybookRunExecutorDetails.md), `any`\>\> - -Get details on execution of the remediation - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Remediation identifier | -| `playbookRunId` | `string` | Playbook run identifier (UUID) | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`PlaybookRunExecutorDetails`](../interfaces/PlaybookRunExecutorDetails.md), `any`\>\> - -**`Summary`** - -Get details on execution of the remediation - -**`Throws`** - -**`Memberof`** - -RemediationsApi - -#### Defined in - -[api.ts:3245](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3245) - -___ - -### getPlaybookRunSystemDetails - -▸ **getPlaybookRunSystemDetails**(`id`, `playbookRunId`, `system`, `options?`): `Promise`\<`AxiosResponse`\<[`PlaybookRunSystemDetails`](../interfaces/PlaybookRunSystemDetails.md), `any`\>\> - -Get details and updated log of system being executed on in specific playbook run - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Remediation identifier | -| `playbookRunId` | `string` | Playbook run identifier (UUID) | -| `system` | `string` | System identifier | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`PlaybookRunSystemDetails`](../interfaces/PlaybookRunSystemDetails.md), `any`\>\> - -**`Summary`** - -Get details and updated log of system being executed on in specific playbook run - -**`Throws`** - -**`Memberof`** - -RemediationsApi - -#### Defined in - -[api.ts:3259](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3259) - -___ - -### getPlaybookRunSystems - -▸ **getPlaybookRunSystems**(`id`, `playbookRunId`, `executor?`, `limit?`, `offset?`, `ansibleHost?`, `sort?`, `options?`): `Promise`\<`AxiosResponse`\<[`PlaybookRunSystemList`](../interfaces/PlaybookRunSystemList.md), `any`\>\> - -Get details on systems being executed on in specific playbook run - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Remediation identifier | -| `playbookRunId` | `string` | Playbook run identifier (UUID) | -| `executor?` | `string` | Playbook run executor identifier (UUID) | -| `limit?` | `number` | Maximum number of results to return | -| `offset?` | `number` | Indicates the starting position of the query relative to the complete set of items that match the query | -| `ansibleHost?` | `string` | System Name (STRING) | -| `sort?` | ``"system_name"`` \| ``"-system_name"`` | Playbook run systems sort order by ASC or DESC | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`PlaybookRunSystemList`](../interfaces/PlaybookRunSystemList.md), `any`\>\> - -**`Summary`** - -Get details on systems being executed on in specific playbook run - -**`Throws`** - -**`Memberof`** - -RemediationsApi - -#### Defined in - -[api.ts:3277](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3277) - -___ - -### getRemediation - -▸ **getRemediation**(`id`, `options?`): `Promise`\<`AxiosResponse`\<[`RemediationDetails`](../interfaces/RemediationDetails.md), `any`\>\> - -Provides information about the given Remediation, RBAC permission {remediations:remediation:read} - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Remediation identifier | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`RemediationDetails`](../interfaces/RemediationDetails.md), `any`\>\> - -**`Summary`** - -Get Remediation - -**`Throws`** - -**`Memberof`** - -RemediationsApi - -#### Defined in - -[api.ts:3289](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3289) - -___ - -### getRemediationConnectionStatus - -▸ **getRemediationConnectionStatus**(`id`, `options?`): `Promise`\<`AxiosResponse`\<[`RemediationConnectionStatus`](../interfaces/RemediationConnectionStatus.md), `any`\>\> - -Get connection status for remediation plan targets, RBAC permission {remediations:remediation:execute} Returns an array of the following objects: - One object for all systems belonging to a unique satellite organization - One object for all direct-connected systems in each of the status categories: - connected - disconnected - no_rhc - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Remediation identifier | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`RemediationConnectionStatus`](../interfaces/RemediationConnectionStatus.md), `any`\>\> - -**`Summary`** - -Pre-flight check - -**`Throws`** - -**`Memberof`** - -RemediationsApi - -#### Defined in - -[api.ts:3301](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3301) - -___ - -### getRemediationIssueSystems - -▸ **getRemediationIssueSystems**(`id`, `issue`, `limit?`, `offset?`, `sort?`, `options?`): `Promise`\<`AxiosResponse`\<[`RemediationIssueSystemList`](../interfaces/RemediationIssueSystemList.md), `any`\>\> - -Get a paginated list of systems from a given issue, RBAC permission {remediations:remediation:read} - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Remediation identifier | -| `issue` | `string` | Issue identifier (e.g. `advisor:CVE_2017_6074_kernel\|KERNEL_CVE_2017_6074`) | -| `limit?` | `number` | Maximum number of results to return | -| `offset?` | `number` | Indicates the starting position of the query relative to the complete set of items that match the query | -| `sort?` | ``"display_name"`` \| ``"-display_name"`` | Sort order | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`RemediationIssueSystemList`](../interfaces/RemediationIssueSystemList.md), `any`\>\> - -**`Summary`** - -Get Remediation Issue Systems - -**`Throws`** - -**`Memberof`** - -RemediationsApi - -#### Defined in - -[api.ts:3317](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3317) - -___ - -### getRemediationPlaybook - -▸ **getRemediationPlaybook**(`id`, `hosts?`, `satOrg?`, `localhost?`, `options?`): `Promise`\<`AxiosResponse`\<`string`, `any`\>\> - -Provides Ansible Playbook, RBAC permission {remediations:remediation:read} - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Remediation identifier | -| `hosts?` | `string`[] | Selected hosts to be included in playbook | -| `satOrg?` | `string` | Organization ID passed by satellite | -| `localhost?` | `boolean` | Flag for localhost playbook generation | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`string`, `any`\>\> - -**`Summary`** - -Get Remediation Playbook - -**`Throws`** - -**`Memberof`** - -RemediationsApi - -#### Defined in - -[api.ts:3332](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3332) - -___ - -### getRemediations - -▸ **getRemediations**(`sort?`, `filter?`, `limit?`, `offset?`, `system?`, `hideArchived?`, `fieldsData?`, `options?`): `Promise`\<`AxiosResponse`\<[`RemediationList`](../interfaces/RemediationList.md) \| [`RemediationNameList`](../interfaces/RemediationNameList.md), `any`\>\> - -Provides information about Remediations, RBAC permission {remediations:remediation:read} - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `sort?` | ``"updated_at"`` \| ``"-updated_at"`` \| ``"name"`` \| ``"-name"`` \| ``"system_count"`` \| ``"-system_count"`` \| ``"issue_count"`` \| ``"-issue_count"`` | Sort order | -| `filter?` | `string` | Remediation name filter. If specified only remediations whose name matches the given string will be returned. | -| `limit?` | `number` | Maximum number of results to return | -| `offset?` | `number` | Indicates the starting position of the query relative to the complete set of items that match the query | -| `system?` | `string` | System identifier. If specified only remediations that involve the given system will be returned. | -| `hideArchived?` | `boolean` | Hide archived playbooks | -| `fieldsData?` | (``"name"`` \| ``"playbook_runs"``)[] | Include specified items - name: list all remediation plan names in organization (cannot be combined with other fields) - playbook_runs: include playbook run data in the response | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`RemediationList`](../interfaces/RemediationList.md) \| [`RemediationNameList`](../interfaces/RemediationNameList.md), `any`\>\> - -**`Summary`** - -List Remediations - -**`Throws`** - -**`Memberof`** - -RemediationsApi - -#### Defined in - -[api.ts:3350](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3350) - -___ - -### listPlaybookRuns - -▸ **listPlaybookRuns**(`id`, `limit?`, `offset?`, `sort?`, `options?`): `Promise`\<`AxiosResponse`\<[`PlaybookRunsList`](../interfaces/PlaybookRunsList.md), `any`\>\> - -List of executions of this remediation - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Remediation identifier | -| `limit?` | `number` | Maximum number of results to return | -| `offset?` | `number` | Indicates the starting position of the query relative to the complete set of items that match the query | -| `sort?` | ``"updated_at"`` \| ``"-updated_at"`` | Sort Order for Playbook Run | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`PlaybookRunsList`](../interfaces/PlaybookRunsList.md), `any`\>\> - -**`Summary`** - -List of executions of this remediation - -**`Throws`** - -**`Memberof`** - -RemediationsApi - -#### Defined in - -[api.ts:3365](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3365) - -___ - -### runRemediation - -▸ **runRemediation**(`id`, `playbookRunsInput?`, `options?`): `Promise`\<`AxiosResponse`\<[`ExecuteRemediation`](../interfaces/ExecuteRemediation.md), `any`\>\> - -Execute remediation, RBAC permission {remediations:remediation:execute} - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Remediation identifier | -| `playbookRunsInput?` | [`PlaybookRunsInput`](../interfaces/PlaybookRunsInput.md) | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`ExecuteRemediation`](../interfaces/ExecuteRemediation.md), `any`\>\> - -**`Summary`** - -Execute remediation - -**`Throws`** - -**`Memberof`** - -RemediationsApi - -#### Defined in - -[api.ts:3378](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3378) - -___ - -### updateRemediation - -▸ **updateRemediation**(`id`, `remediationInput`, `options?`): `Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -Updates the given Remediation, RBAC permission {remediations:remediation:write} - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Remediation identifier | -| `remediationInput` | [`RemediationInput`](../interfaces/RemediationInput.md) | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -**`Summary`** - -Update Remediation - -**`Throws`** - -**`Memberof`** - -RemediationsApi - -#### Defined in - -[api.ts:3391](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3391) - -___ - -### updateRemediationIssue - -▸ **updateRemediationIssue**(`id`, `issue`, `remediationIssueIn`, `options?`): `Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -Updates the given Remediation Issue, RBAC permission {remediations:remediation:write} - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Remediation identifier | -| `issue` | `string` | Issue identifier (e.g. `advisor:CVE_2017_6074_kernel\|KERNEL_CVE_2017_6074`) | -| `remediationIssueIn` | [`RemediationIssueIn`](../interfaces/RemediationIssueIn.md) | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -**`Summary`** - -Update Remediation Issue - -**`Throws`** - -**`Memberof`** - -RemediationsApi - -#### Defined in - -[api.ts:3405](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3405) diff --git a/packages/remediations/doc/classes/ResolutionsApi.md b/packages/remediations/doc/classes/ResolutionsApi.md deleted file mode 100644 index 3458248df..000000000 --- a/packages/remediations/doc/classes/ResolutionsApi.md +++ /dev/null @@ -1,166 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / ResolutionsApi - -# Class: ResolutionsApi - -ResolutionsApi - object-oriented interface - -**`Export`** - -ResolutionsApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`ResolutionsApi`** - -## Table of contents - -### Constructors - -- [constructor](ResolutionsApi.md#constructor) - -### Properties - -- [axios](ResolutionsApi.md#axios) -- [basePath](ResolutionsApi.md#basepath) -- [configuration](ResolutionsApi.md#configuration) - -### Methods - -- [getResolutionsForIssue](ResolutionsApi.md#getresolutionsforissue) -- [getResolutionsForIssues](ResolutionsApi.md#getresolutionsforissues) - -## Constructors - -### constructor - -• **new ResolutionsApi**(`configuration?`, `basePath?`, `axios?`): [`ResolutionsApi`](ResolutionsApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`ResolutionsApi`](ResolutionsApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/base.ts#L49) - -## Methods - -### getResolutionsForIssue - -▸ **getResolutionsForIssue**(`issue`, `options?`): `Promise`\<`AxiosResponse`\<[`Resolutions`](../interfaces/Resolutions.md), `any`\>\> - -Provides information about resolutions available for the given issue - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `issue` | `string` | Issue identifier (e.g. `advisor:CVE_2017_6074_kernel\|KERNEL_CVE_2017_6074`) | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`Resolutions`](../interfaces/Resolutions.md), `any`\>\> - -**`Summary`** - -Resolution metadata - -**`Throws`** - -**`Memberof`** - -ResolutionsApi - -#### Defined in - -[api.ts:3577](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3577) - -___ - -### getResolutionsForIssues - -▸ **getResolutionsForIssues**(`resolutionsBatchInput`, `options?`): `Promise`\<`AxiosResponse`\<\{ `[key: string]`: [`Resolutions`](../interfaces/Resolutions.md) \| `boolean`; }, `any`\>\> - -Provides information about resolutions available for the given issues - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `resolutionsBatchInput` | [`ResolutionsBatchInput`](../interfaces/ResolutionsBatchInput.md) | | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<\{ `[key: string]`: [`Resolutions`](../interfaces/Resolutions.md) \| `boolean`; }, `any`\>\> - -**`Summary`** - -Resolution metadata (batch) - -**`Throws`** - -**`Memberof`** - -ResolutionsApi - -#### Defined in - -[api.ts:3589](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3589) diff --git a/packages/remediations/doc/classes/VersionApi.md b/packages/remediations/doc/classes/VersionApi.md deleted file mode 100644 index 3e4c875d4..000000000 --- a/packages/remediations/doc/classes/VersionApi.md +++ /dev/null @@ -1,131 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / VersionApi - -# Class: VersionApi - -VersionApi - object-oriented interface - -**`Export`** - -VersionApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`VersionApi`** - -## Table of contents - -### Constructors - -- [constructor](VersionApi.md#constructor) - -### Properties - -- [axios](VersionApi.md#axios) -- [basePath](VersionApi.md#basepath) -- [configuration](VersionApi.md#configuration) - -### Methods - -- [getVersion](VersionApi.md#getversion) - -## Constructors - -### constructor - -• **new VersionApi**(`configuration?`, `basePath?`, `axios?`): [`VersionApi`](VersionApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`VersionApi`](VersionApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/base.ts#L49) - -## Methods - -### getVersion - -▸ **getVersion**(`options?`): `Promise`\<`AxiosResponse`\<[`InlineResponse200`](../interfaces/InlineResponse200.md), `any`\>\> - -Provides information about the version of the service - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`InlineResponse200`](../interfaces/InlineResponse200.md), `any`\>\> - -**`Summary`** - -Get service version - -**`Throws`** - -**`Memberof`** - -VersionApi - -#### Defined in - -[api.ts:3689](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3689) diff --git a/packages/remediations/doc/enums/PlaybookExecutorStatusConnectionStatusEnum.md b/packages/remediations/doc/enums/PlaybookExecutorStatusConnectionStatusEnum.md deleted file mode 100644 index c0e806d24..000000000 --- a/packages/remediations/doc/enums/PlaybookExecutorStatusConnectionStatusEnum.md +++ /dev/null @@ -1,43 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / PlaybookExecutorStatusConnectionStatusEnum - -# Enumeration: PlaybookExecutorStatusConnectionStatusEnum - -**`Export`** - -## Table of contents - -### Enumeration Members - -- [Connected](PlaybookExecutorStatusConnectionStatusEnum.md#connected) -- [Disconnected](PlaybookExecutorStatusConnectionStatusEnum.md#disconnected) -- [NoRhc](PlaybookExecutorStatusConnectionStatusEnum.md#norhc) - -## Enumeration Members - -### Connected - -• **Connected** = ``"connected"`` - -#### Defined in - -[api.ts:346](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L346) - -___ - -### Disconnected - -• **Disconnected** = ``"disconnected"`` - -#### Defined in - -[api.ts:347](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L347) - -___ - -### NoRhc - -• **NoRhc** = ``"no_rhc"`` - -#### Defined in - -[api.ts:348](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L348) diff --git a/packages/remediations/doc/enums/PlaybookRunExecutorStatus.md b/packages/remediations/doc/enums/PlaybookRunExecutorStatus.md deleted file mode 100644 index 0dec7f138..000000000 --- a/packages/remediations/doc/enums/PlaybookRunExecutorStatus.md +++ /dev/null @@ -1,76 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / PlaybookRunExecutorStatus - -# Enumeration: PlaybookRunExecutorStatus - -**`Export`** - -## Table of contents - -### Enumeration Members - -- [Acked](PlaybookRunExecutorStatus.md#acked) -- [Canceled](PlaybookRunExecutorStatus.md#canceled) -- [Failure](PlaybookRunExecutorStatus.md#failure) -- [Pending](PlaybookRunExecutorStatus.md#pending) -- [Running](PlaybookRunExecutorStatus.md#running) -- [Success](PlaybookRunExecutorStatus.md#success) - -## Enumeration Members - -### Acked - -• **Acked** = ``"acked"`` - -#### Defined in - -[api.ts:493](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L493) - -___ - -### Canceled - -• **Canceled** = ``"canceled"`` - -#### Defined in - -[api.ts:497](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L497) - -___ - -### Failure - -• **Failure** = ``"failure"`` - -#### Defined in - -[api.ts:496](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L496) - -___ - -### Pending - -• **Pending** = ``"pending"`` - -#### Defined in - -[api.ts:492](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L492) - -___ - -### Running - -• **Running** = ``"running"`` - -#### Defined in - -[api.ts:494](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L494) - -___ - -### Success - -• **Success** = ``"success"`` - -#### Defined in - -[api.ts:495](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L495) diff --git a/packages/remediations/doc/enums/PlaybookRunStatus.md b/packages/remediations/doc/enums/PlaybookRunStatus.md deleted file mode 100644 index 04beadd46..000000000 --- a/packages/remediations/doc/enums/PlaybookRunStatus.md +++ /dev/null @@ -1,65 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / PlaybookRunStatus - -# Enumeration: PlaybookRunStatus - -**`Export`** - -## Table of contents - -### Enumeration Members - -- [Canceled](PlaybookRunStatus.md#canceled) -- [Failure](PlaybookRunStatus.md#failure) -- [Pending](PlaybookRunStatus.md#pending) -- [Running](PlaybookRunStatus.md#running) -- [Success](PlaybookRunStatus.md#success) - -## Enumeration Members - -### Canceled - -• **Canceled** = ``"canceled"`` - -#### Defined in - -[api.ts:510](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L510) - -___ - -### Failure - -• **Failure** = ``"failure"`` - -#### Defined in - -[api.ts:509](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L509) - -___ - -### Pending - -• **Pending** = ``"pending"`` - -#### Defined in - -[api.ts:506](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L506) - -___ - -### Running - -• **Running** = ``"running"`` - -#### Defined in - -[api.ts:507](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L507) - -___ - -### Success - -• **Success** = ``"success"`` - -#### Defined in - -[api.ts:508](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L508) diff --git a/packages/remediations/doc/enums/PlaybookRunSystemStatus.md b/packages/remediations/doc/enums/PlaybookRunSystemStatus.md deleted file mode 100644 index b5220dd4c..000000000 --- a/packages/remediations/doc/enums/PlaybookRunSystemStatus.md +++ /dev/null @@ -1,65 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / PlaybookRunSystemStatus - -# Enumeration: PlaybookRunSystemStatus - -**`Export`** - -## Table of contents - -### Enumeration Members - -- [Canceled](PlaybookRunSystemStatus.md#canceled) -- [Failure](PlaybookRunSystemStatus.md#failure) -- [Pending](PlaybookRunSystemStatus.md#pending) -- [Running](PlaybookRunSystemStatus.md#running) -- [Success](PlaybookRunSystemStatus.md#success) - -## Enumeration Members - -### Canceled - -• **Canceled** = ``"canceled"`` - -#### Defined in - -[api.ts:585](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L585) - -___ - -### Failure - -• **Failure** = ``"failure"`` - -#### Defined in - -[api.ts:584](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L584) - -___ - -### Pending - -• **Pending** = ``"pending"`` - -#### Defined in - -[api.ts:581](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L581) - -___ - -### Running - -• **Running** = ``"running"`` - -#### Defined in - -[api.ts:582](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L582) - -___ - -### Success - -• **Success** = ``"success"`` - -#### Defined in - -[api.ts:583](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L583) diff --git a/packages/remediations/doc/enums/ResolutionRisk.md b/packages/remediations/doc/enums/ResolutionRisk.md deleted file mode 100644 index e7862b892..000000000 --- a/packages/remediations/doc/enums/ResolutionRisk.md +++ /dev/null @@ -1,65 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / ResolutionRisk - -# Enumeration: ResolutionRisk - -**`Export`** - -## Table of contents - -### Enumeration Members - -- [NUMBER\_1](ResolutionRisk.md#number_1) -- [NUMBER\_2](ResolutionRisk.md#number_2) -- [NUMBER\_3](ResolutionRisk.md#number_3) -- [NUMBER\_4](ResolutionRisk.md#number_4) -- [NUMBER\_MINUS\_1](ResolutionRisk.md#number_minus_1) - -## Enumeration Members - -### NUMBER\_1 - -• **NUMBER\_1** = ``1`` - -#### Defined in - -[api.ts:1180](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1180) - -___ - -### NUMBER\_2 - -• **NUMBER\_2** = ``2`` - -#### Defined in - -[api.ts:1181](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1181) - -___ - -### NUMBER\_3 - -• **NUMBER\_3** = ``3`` - -#### Defined in - -[api.ts:1182](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1182) - -___ - -### NUMBER\_4 - -• **NUMBER\_4** = ``4`` - -#### Defined in - -[api.ts:1183](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1183) - -___ - -### NUMBER\_MINUS\_1 - -• **NUMBER\_MINUS\_1** = ``-1`` - -#### Defined in - -[api.ts:1179](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1179) diff --git a/packages/remediations/doc/interfaces/ConfigurationParameters.md b/packages/remediations/doc/interfaces/ConfigurationParameters.md deleted file mode 100644 index 3eb72c372..000000000 --- a/packages/remediations/doc/interfaces/ConfigurationParameters.md +++ /dev/null @@ -1,84 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / ConfigurationParameters - -# Interface: ConfigurationParameters - -Insights Remediations -Insights Remediations Service - -The version of the OpenAPI document: 1.5.0 -Contact: rewhite@redhat.com - -NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -https://openapi-generator.tech -Do not edit the class manually. - -## Table of contents - -### Properties - -- [accessToken](ConfigurationParameters.md#accesstoken) -- [apiKey](ConfigurationParameters.md#apikey) -- [baseOptions](ConfigurationParameters.md#baseoptions) -- [basePath](ConfigurationParameters.md#basepath) -- [password](ConfigurationParameters.md#password) -- [username](ConfigurationParameters.md#username) - -## Properties - -### accessToken - -• `Optional` **accessToken**: `string` \| (`name?`: `string`, `scopes?`: `string`[]) => `string` - -#### Defined in - -[configuration.ts:19](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/configuration.ts#L19) - -___ - -### apiKey - -• `Optional` **apiKey**: `string` \| `Promise`\<`string`\> \| (`name`: `string`) => `string` \| (`name`: `string`) => `Promise`\<`string`\> - -#### Defined in - -[configuration.ts:16](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/configuration.ts#L16) - -___ - -### baseOptions - -• `Optional` **baseOptions**: `any` - -#### Defined in - -[configuration.ts:21](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/configuration.ts#L21) - -___ - -### basePath - -• `Optional` **basePath**: `string` - -#### Defined in - -[configuration.ts:20](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/configuration.ts#L20) - -___ - -### password - -• `Optional` **password**: `string` - -#### Defined in - -[configuration.ts:18](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/configuration.ts#L18) - -___ - -### username - -• `Optional` **username**: `string` - -#### Defined in - -[configuration.ts:17](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/configuration.ts#L17) diff --git a/packages/remediations/doc/interfaces/Counts.md b/packages/remediations/doc/interfaces/Counts.md deleted file mode 100644 index bed53d2dd..000000000 --- a/packages/remediations/doc/interfaces/Counts.md +++ /dev/null @@ -1,87 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / Counts - -# Interface: Counts - -**`Export`** - -Counts - -## Table of contents - -### Properties - -- [canceled](Counts.md#canceled) -- [failure](Counts.md#failure) -- [pending](Counts.md#pending) -- [running](Counts.md#running) -- [success](Counts.md#success) - -## Properties - -### canceled - -• **canceled**: `number` - -**`Memberof`** - -Counts - -#### Defined in - -[api.ts:57](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L57) - -___ - -### failure - -• **failure**: `number` - -**`Memberof`** - -Counts - -#### Defined in - -[api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L51) - -___ - -### pending - -• **pending**: `number` - -**`Memberof`** - -Counts - -#### Defined in - -[api.ts:33](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L33) - -___ - -### running - -• **running**: `number` - -**`Memberof`** - -Counts - -#### Defined in - -[api.ts:39](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L39) - -___ - -### success - -• **success**: `number` - -**`Memberof`** - -Counts - -#### Defined in - -[api.ts:45](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L45) diff --git a/packages/remediations/doc/interfaces/Diagnosis.md b/packages/remediations/doc/interfaces/Diagnosis.md deleted file mode 100644 index 016af93b5..000000000 --- a/packages/remediations/doc/interfaces/Diagnosis.md +++ /dev/null @@ -1,61 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / Diagnosis - -# Interface: Diagnosis - -**`Export`** - -Diagnosis - -## Table of contents - -### Properties - -- [details](Diagnosis.md#details) -- [id](Diagnosis.md#id) -- [insights\_id](Diagnosis.md#insights_id) - -## Properties - -### details - -• **details**: `Object` - -**`Memberof`** - -Diagnosis - -#### Index signature - -▪ [key: `string`]: `object` - -#### Defined in - -[api.ts:82](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L82) - -___ - -### id - -• **id**: `string` - -**`Memberof`** - -Diagnosis - -#### Defined in - -[api.ts:70](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L70) - -___ - -### insights\_id - -• **insights\_id**: `string` - -**`Memberof`** - -Diagnosis - -#### Defined in - -[api.ts:76](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L76) diff --git a/packages/remediations/doc/interfaces/ExecuteRemediation.md b/packages/remediations/doc/interfaces/ExecuteRemediation.md deleted file mode 100644 index a8318e629..000000000 --- a/packages/remediations/doc/interfaces/ExecuteRemediation.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / ExecuteRemediation - -# Interface: ExecuteRemediation - -**`Export`** - -ExecuteRemediation - -## Table of contents - -### Properties - -- [id](ExecuteRemediation.md#id) - -## Properties - -### id - -• **id**: `string` - -**`Memberof`** - -ExecuteRemediation - -#### Defined in - -[api.ts:95](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L95) diff --git a/packages/remediations/doc/interfaces/InlineResponse200.md b/packages/remediations/doc/interfaces/InlineResponse200.md deleted file mode 100644 index df9513ddf..000000000 --- a/packages/remediations/doc/interfaces/InlineResponse200.md +++ /dev/null @@ -1,42 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / InlineResponse200 - -# Interface: InlineResponse200 - -**`Export`** - -InlineResponse200 - -## Table of contents - -### Properties - -- [commit](InlineResponse200.md#commit) -- [version](InlineResponse200.md#version) - -## Properties - -### commit - -• **commit**: `string` - -**`Memberof`** - -InlineResponse200 - -#### Defined in - -[api.ts:114](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L114) - -___ - -### version - -• **version**: `string` - -**`Memberof`** - -InlineResponse200 - -#### Defined in - -[api.ts:108](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L108) diff --git a/packages/remediations/doc/interfaces/Meta.md b/packages/remediations/doc/interfaces/Meta.md deleted file mode 100644 index 18d43c499..000000000 --- a/packages/remediations/doc/interfaces/Meta.md +++ /dev/null @@ -1,46 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / Meta - -# Interface: Meta - -**`Export`** - -Meta - -## Table of contents - -### Properties - -- [count](Meta.md#count) -- [total](Meta.md#total) - -## Properties - -### count - -• **count**: `number` - -number of results returned - -**`Memberof`** - -Meta - -#### Defined in - -[api.ts:127](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L127) - -___ - -### total - -• **total**: `number` - -total number of results matching the query - -**`Memberof`** - -Meta - -#### Defined in - -[api.ts:133](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L133) diff --git a/packages/remediations/doc/interfaces/MultipleDelete.md b/packages/remediations/doc/interfaces/MultipleDelete.md deleted file mode 100644 index b96c35726..000000000 --- a/packages/remediations/doc/interfaces/MultipleDelete.md +++ /dev/null @@ -1,29 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / MultipleDelete - -# Interface: MultipleDelete - -**`Export`** - -MultipleDelete - -## Table of contents - -### Properties - -- [deleted\_count](MultipleDelete.md#deleted_count) - -## Properties - -### deleted\_count - -• **deleted\_count**: `number` - -Count of remediations deleted - -**`Memberof`** - -MultipleDelete - -#### Defined in - -[api.ts:146](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L146) diff --git a/packages/remediations/doc/interfaces/NoExecutors.md b/packages/remediations/doc/interfaces/NoExecutors.md deleted file mode 100644 index 3af253bdb..000000000 --- a/packages/remediations/doc/interfaces/NoExecutors.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / NoExecutors - -# Interface: NoExecutors - -**`Export`** - -NoExecutors - -## Table of contents - -### Properties - -- [errors](NoExecutors.md#errors) - -## Properties - -### errors - -• **errors**: [`NoExecutorsErrors`](NoExecutorsErrors.md)[] - -**`Memberof`** - -NoExecutors - -#### Defined in - -[api.ts:159](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L159) diff --git a/packages/remediations/doc/interfaces/NoExecutorsErrors.md b/packages/remediations/doc/interfaces/NoExecutorsErrors.md deleted file mode 100644 index 68b711b89..000000000 --- a/packages/remediations/doc/interfaces/NoExecutorsErrors.md +++ /dev/null @@ -1,72 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / NoExecutorsErrors - -# Interface: NoExecutorsErrors - -**`Export`** - -NoExecutorsErrors - -## Table of contents - -### Properties - -- [code](NoExecutorsErrors.md#code) -- [id](NoExecutorsErrors.md#id) -- [status](NoExecutorsErrors.md#status) -- [title](NoExecutorsErrors.md#title) - -## Properties - -### code - -• `Optional` **code**: `string` - -**`Memberof`** - -NoExecutorsErrors - -#### Defined in - -[api.ts:184](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L184) - -___ - -### id - -• **id**: `string` - -**`Memberof`** - -NoExecutorsErrors - -#### Defined in - -[api.ts:172](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L172) - -___ - -### status - -• `Optional` **status**: `number` - -**`Memberof`** - -NoExecutorsErrors - -#### Defined in - -[api.ts:178](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L178) - -___ - -### title - -• `Optional` **title**: `string` - -**`Memberof`** - -NoExecutorsErrors - -#### Defined in - -[api.ts:190](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L190) diff --git a/packages/remediations/doc/interfaces/PlaybookDefinition.md b/packages/remediations/doc/interfaces/PlaybookDefinition.md deleted file mode 100644 index 656ffb8ca..000000000 --- a/packages/remediations/doc/interfaces/PlaybookDefinition.md +++ /dev/null @@ -1,44 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / PlaybookDefinition - -# Interface: PlaybookDefinition - -**`Export`** - -PlaybookDefinition - -## Table of contents - -### Properties - -- [auto\_reboot](PlaybookDefinition.md#auto_reboot) -- [issues](PlaybookDefinition.md#issues) - -## Properties - -### auto\_reboot - -• `Optional` **auto\_reboot**: `boolean` - -Indicates whether systems that require reboot for the remediation to be properly applied should be rebooted automatically or not - -**`Memberof`** - -PlaybookDefinition - -#### Defined in - -[api.ts:209](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L209) - -___ - -### issues - -• **issues**: [`PlaybookDefinitionIssues`](PlaybookDefinitionIssues.md)[] - -**`Memberof`** - -PlaybookDefinition - -#### Defined in - -[api.ts:203](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L203) diff --git a/packages/remediations/doc/interfaces/PlaybookDefinitionIssues.md b/packages/remediations/doc/interfaces/PlaybookDefinitionIssues.md deleted file mode 100644 index cb66393ba..000000000 --- a/packages/remediations/doc/interfaces/PlaybookDefinitionIssues.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / PlaybookDefinitionIssues - -# Interface: PlaybookDefinitionIssues - -**`Export`** - -PlaybookDefinitionIssues - -## Table of contents - -### Properties - -- [id](PlaybookDefinitionIssues.md#id) -- [resolution](PlaybookDefinitionIssues.md#resolution) -- [systems](PlaybookDefinitionIssues.md#systems) - -## Properties - -### id - -• **id**: `string` - -**`Memberof`** - -PlaybookDefinitionIssues - -#### Defined in - -[api.ts:222](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L222) - -___ - -### resolution - -• `Optional` **resolution**: `string` - -**`Memberof`** - -PlaybookDefinitionIssues - -#### Defined in - -[api.ts:234](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L234) - -___ - -### systems - -• **systems**: `string`[] - -**`Memberof`** - -PlaybookDefinitionIssues - -#### Defined in - -[api.ts:228](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L228) diff --git a/packages/remediations/doc/interfaces/PlaybookExecutorDetails.md b/packages/remediations/doc/interfaces/PlaybookExecutorDetails.md deleted file mode 100644 index 898b60ccb..000000000 --- a/packages/remediations/doc/interfaces/PlaybookExecutorDetails.md +++ /dev/null @@ -1,134 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / PlaybookExecutorDetails - -# Interface: PlaybookExecutorDetails - -**`Export`** - -PlaybookExecutorDetails - -## Table of contents - -### Properties - -- [counts](PlaybookExecutorDetails.md#counts) -- [executor\_id](PlaybookExecutorDetails.md#executor_id) -- [executor\_name](PlaybookExecutorDetails.md#executor_name) -- [playbook](PlaybookExecutorDetails.md#playbook) -- [playbook\_run\_id](PlaybookExecutorDetails.md#playbook_run_id) -- [status](PlaybookExecutorDetails.md#status) -- [system\_count](PlaybookExecutorDetails.md#system_count) -- [updated\_at](PlaybookExecutorDetails.md#updated_at) - -## Properties - -### counts - -• `Optional` **counts**: [`Counts`](Counts.md) - -**`Memberof`** - -PlaybookExecutorDetails - -#### Defined in - -[api.ts:283](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L283) - -___ - -### executor\_id - -• **executor\_id**: `string` - -**`Memberof`** - -PlaybookExecutorDetails - -#### Defined in - -[api.ts:247](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L247) - -___ - -### executor\_name - -• **executor\_name**: `string` - -**`Memberof`** - -PlaybookExecutorDetails - -#### Defined in - -[api.ts:253](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L253) - -___ - -### playbook - -• **playbook**: `string` - -Playbook created for the playbook run executor. - -**`Memberof`** - -PlaybookExecutorDetails - -#### Defined in - -[api.ts:265](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L265) - -___ - -### playbook\_run\_id - -• **playbook\_run\_id**: `string` - -**`Memberof`** - -PlaybookExecutorDetails - -#### Defined in - -[api.ts:271](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L271) - -___ - -### status - -• **status**: [`PlaybookRunExecutorStatus`](../enums/PlaybookRunExecutorStatus.md) - -**`Memberof`** - -PlaybookExecutorDetails - -#### Defined in - -[api.ts:289](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L289) - -___ - -### system\_count - -• **system\_count**: `number` - -**`Memberof`** - -PlaybookExecutorDetails - -#### Defined in - -[api.ts:277](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L277) - -___ - -### updated\_at - -• **updated\_at**: `string` - -**`Memberof`** - -PlaybookExecutorDetails - -#### Defined in - -[api.ts:259](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L259) diff --git a/packages/remediations/doc/interfaces/PlaybookExecutorStatus.md b/packages/remediations/doc/interfaces/PlaybookExecutorStatus.md deleted file mode 100644 index 9f2b0ab2d..000000000 --- a/packages/remediations/doc/interfaces/PlaybookExecutorStatus.md +++ /dev/null @@ -1,117 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / PlaybookExecutorStatus - -# Interface: PlaybookExecutorStatus - -**`Export`** - -PlaybookExecutorStatus - -## Table of contents - -### Properties - -- [connection\_status](PlaybookExecutorStatus.md#connection_status) -- [endpoint\_id](PlaybookExecutorStatus.md#endpoint_id) -- [executor\_id](PlaybookExecutorStatus.md#executor_id) -- [executor\_name](PlaybookExecutorStatus.md#executor_name) -- [executor\_type](PlaybookExecutorStatus.md#executor_type) -- [system\_count](PlaybookExecutorStatus.md#system_count) -- [system\_ids](PlaybookExecutorStatus.md#system_ids) - -## Properties - -### connection\_status - -• **connection\_status**: [`PlaybookExecutorStatusConnectionStatusEnum`](../enums/PlaybookExecutorStatusConnectionStatusEnum.md) - -**`Memberof`** - -PlaybookExecutorStatus - -#### Defined in - -[api.ts:338](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L338) - -___ - -### endpoint\_id - -• **endpoint\_id**: ``null`` \| `string` - -**`Memberof`** - -PlaybookExecutorStatus - -#### Defined in - -[api.ts:302](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L302) - -___ - -### executor\_id - -• **executor\_id**: ``null`` \| `string` - -**`Memberof`** - -PlaybookExecutorStatus - -#### Defined in - -[api.ts:308](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L308) - -___ - -### executor\_name - -• **executor\_name**: ``null`` \| `string` - -**`Memberof`** - -PlaybookExecutorStatus - -#### Defined in - -[api.ts:320](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L320) - -___ - -### executor\_type - -• **executor\_type**: ``null`` \| `string` - -**`Memberof`** - -PlaybookExecutorStatus - -#### Defined in - -[api.ts:314](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L314) - -___ - -### system\_count - -• **system\_count**: `number` - -**`Memberof`** - -PlaybookExecutorStatus - -#### Defined in - -[api.ts:326](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L326) - -___ - -### system\_ids - -• **system\_ids**: `string`[] - -**`Memberof`** - -PlaybookExecutorStatus - -#### Defined in - -[api.ts:332](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L332) diff --git a/packages/remediations/doc/interfaces/PlaybookExecutors.md b/packages/remediations/doc/interfaces/PlaybookExecutors.md deleted file mode 100644 index dd5c8f8c7..000000000 --- a/packages/remediations/doc/interfaces/PlaybookExecutors.md +++ /dev/null @@ -1,87 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / PlaybookExecutors - -# Interface: PlaybookExecutors - -**`Export`** - -PlaybookExecutors - -## Table of contents - -### Properties - -- [counts](PlaybookExecutors.md#counts) -- [executor\_id](PlaybookExecutors.md#executor_id) -- [executor\_name](PlaybookExecutors.md#executor_name) -- [status](PlaybookExecutors.md#status) -- [system\_count](PlaybookExecutors.md#system_count) - -## Properties - -### counts - -• **counts**: [`Counts`](Counts.md) - -**`Memberof`** - -PlaybookExecutors - -#### Defined in - -[api.ts:386](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L386) - -___ - -### executor\_id - -• **executor\_id**: `string` - -**`Memberof`** - -PlaybookExecutors - -#### Defined in - -[api.ts:362](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L362) - -___ - -### executor\_name - -• **executor\_name**: `string` - -**`Memberof`** - -PlaybookExecutors - -#### Defined in - -[api.ts:368](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L368) - -___ - -### status - -• **status**: [`PlaybookRunExecutorStatus`](../enums/PlaybookRunExecutorStatus.md) - -**`Memberof`** - -PlaybookExecutors - -#### Defined in - -[api.ts:374](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L374) - -___ - -### system\_count - -• **system\_count**: `number` - -**`Memberof`** - -PlaybookExecutors - -#### Defined in - -[api.ts:380](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L380) diff --git a/packages/remediations/doc/interfaces/PlaybookRunDetails.md b/packages/remediations/doc/interfaces/PlaybookRunDetails.md deleted file mode 100644 index b66d7a25c..000000000 --- a/packages/remediations/doc/interfaces/PlaybookRunDetails.md +++ /dev/null @@ -1,117 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / PlaybookRunDetails - -# Interface: PlaybookRunDetails - -**`Export`** - -PlaybookRunDetails - -## Table of contents - -### Properties - -- [created\_at](PlaybookRunDetails.md#created_at) -- [created\_by](PlaybookRunDetails.md#created_by) -- [executors](PlaybookRunDetails.md#executors) -- [id](PlaybookRunDetails.md#id) -- [remediation\_id](PlaybookRunDetails.md#remediation_id) -- [status](PlaybookRunDetails.md#status) -- [updated\_at](PlaybookRunDetails.md#updated_at) - -## Properties - -### created\_at - -• **created\_at**: `string` - -**`Memberof`** - -PlaybookRunDetails - -#### Defined in - -[api.ts:423](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L423) - -___ - -### created\_by - -• **created\_by**: [`UserOut`](UserOut.md) - -**`Memberof`** - -PlaybookRunDetails - -#### Defined in - -[api.ts:417](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L417) - -___ - -### executors - -• **executors**: [`PlaybookExecutors`](PlaybookExecutors.md)[] - -**`Memberof`** - -PlaybookRunDetails - -#### Defined in - -[api.ts:405](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L405) - -___ - -### id - -• **id**: `string` - -**`Memberof`** - -PlaybookRunDetails - -#### Defined in - -[api.ts:399](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L399) - -___ - -### remediation\_id - -• **remediation\_id**: `string` - -**`Memberof`** - -PlaybookRunDetails - -#### Defined in - -[api.ts:411](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L411) - -___ - -### status - -• **status**: [`PlaybookRunStatus`](../enums/PlaybookRunStatus.md) - -**`Memberof`** - -PlaybookRunDetails - -#### Defined in - -[api.ts:435](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L435) - -___ - -### updated\_at - -• **updated\_at**: `string` - -**`Memberof`** - -PlaybookRunDetails - -#### Defined in - -[api.ts:429](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L429) diff --git a/packages/remediations/doc/interfaces/PlaybookRunExecutorDetails.md b/packages/remediations/doc/interfaces/PlaybookRunExecutorDetails.md deleted file mode 100644 index 3d82c90f7..000000000 --- a/packages/remediations/doc/interfaces/PlaybookRunExecutorDetails.md +++ /dev/null @@ -1,117 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / PlaybookRunExecutorDetails - -# Interface: PlaybookRunExecutorDetails - -**`Export`** - -PlaybookRunExecutorDetails - -## Table of contents - -### Properties - -- [created\_at](PlaybookRunExecutorDetails.md#created_at) -- [created\_by](PlaybookRunExecutorDetails.md#created_by) -- [executors](PlaybookRunExecutorDetails.md#executors) -- [id](PlaybookRunExecutorDetails.md#id) -- [remediation\_id](PlaybookRunExecutorDetails.md#remediation_id) -- [status](PlaybookRunExecutorDetails.md#status) -- [updated\_at](PlaybookRunExecutorDetails.md#updated_at) - -## Properties - -### created\_at - -• **created\_at**: `string` - -**`Memberof`** - -PlaybookRunExecutorDetails - -#### Defined in - -[api.ts:472](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L472) - -___ - -### created\_by - -• **created\_by**: [`UserOut`](UserOut.md) - -**`Memberof`** - -PlaybookRunExecutorDetails - -#### Defined in - -[api.ts:466](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L466) - -___ - -### executors - -• **executors**: [`PlaybookExecutorDetails`](PlaybookExecutorDetails.md)[] - -**`Memberof`** - -PlaybookRunExecutorDetails - -#### Defined in - -[api.ts:454](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L454) - -___ - -### id - -• `Optional` **id**: `string` - -**`Memberof`** - -PlaybookRunExecutorDetails - -#### Defined in - -[api.ts:448](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L448) - -___ - -### remediation\_id - -• **remediation\_id**: `string` - -**`Memberof`** - -PlaybookRunExecutorDetails - -#### Defined in - -[api.ts:460](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L460) - -___ - -### status - -• **status**: [`PlaybookRunStatus`](../enums/PlaybookRunStatus.md) - -**`Memberof`** - -PlaybookRunExecutorDetails - -#### Defined in - -[api.ts:484](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L484) - -___ - -### updated\_at - -• **updated\_at**: `string` - -**`Memberof`** - -PlaybookRunExecutorDetails - -#### Defined in - -[api.ts:478](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L478) diff --git a/packages/remediations/doc/interfaces/PlaybookRunSystemDetails.md b/packages/remediations/doc/interfaces/PlaybookRunSystemDetails.md deleted file mode 100644 index d9d3a06e2..000000000 --- a/packages/remediations/doc/interfaces/PlaybookRunSystemDetails.md +++ /dev/null @@ -1,104 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / PlaybookRunSystemDetails - -# Interface: PlaybookRunSystemDetails - -**`Export`** - -PlaybookRunSystemDetails - -## Table of contents - -### Properties - -- [console](PlaybookRunSystemDetails.md#console) -- [playbook\_run\_executor\_id](PlaybookRunSystemDetails.md#playbook_run_executor_id) -- [status](PlaybookRunSystemDetails.md#status) -- [system\_id](PlaybookRunSystemDetails.md#system_id) -- [system\_name](PlaybookRunSystemDetails.md#system_name) -- [updated\_at](PlaybookRunSystemDetails.md#updated_at) - -## Properties - -### console - -• **console**: `string` - -Current formatted system log from playbook run system. - -**`Memberof`** - -PlaybookRunSystemDetails - -#### Defined in - -[api.ts:542](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L542) - -___ - -### playbook\_run\_executor\_id - -• **playbook\_run\_executor\_id**: `string` - -**`Memberof`** - -PlaybookRunSystemDetails - -#### Defined in - -[api.ts:548](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L548) - -___ - -### status - -• **status**: [`PlaybookRunSystemStatus`](../enums/PlaybookRunSystemStatus.md) - -**`Memberof`** - -PlaybookRunSystemDetails - -#### Defined in - -[api.ts:536](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L536) - -___ - -### system\_id - -• **system\_id**: `string` - -**`Memberof`** - -PlaybookRunSystemDetails - -#### Defined in - -[api.ts:524](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L524) - -___ - -### system\_name - -• **system\_name**: `string` - -**`Memberof`** - -PlaybookRunSystemDetails - -#### Defined in - -[api.ts:530](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L530) - -___ - -### updated\_at - -• **updated\_at**: `string` - -**`Memberof`** - -PlaybookRunSystemDetails - -#### Defined in - -[api.ts:554](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L554) diff --git a/packages/remediations/doc/interfaces/PlaybookRunSystemList.md b/packages/remediations/doc/interfaces/PlaybookRunSystemList.md deleted file mode 100644 index 65a4c87b9..000000000 --- a/packages/remediations/doc/interfaces/PlaybookRunSystemList.md +++ /dev/null @@ -1,42 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / PlaybookRunSystemList - -# Interface: PlaybookRunSystemList - -**`Export`** - -PlaybookRunSystemList - -## Table of contents - -### Properties - -- [data](PlaybookRunSystemList.md#data) -- [meta](PlaybookRunSystemList.md#meta) - -## Properties - -### data - -• **data**: [`PlaybookRunSystems`](PlaybookRunSystems.md)[] - -**`Memberof`** - -PlaybookRunSystemList - -#### Defined in - -[api.ts:567](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L567) - -___ - -### meta - -• **meta**: [`Meta`](Meta.md) - -**`Memberof`** - -PlaybookRunSystemList - -#### Defined in - -[api.ts:573](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L573) diff --git a/packages/remediations/doc/interfaces/PlaybookRunSystems.md b/packages/remediations/doc/interfaces/PlaybookRunSystems.md deleted file mode 100644 index 111dc54a2..000000000 --- a/packages/remediations/doc/interfaces/PlaybookRunSystems.md +++ /dev/null @@ -1,87 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / PlaybookRunSystems - -# Interface: PlaybookRunSystems - -**`Export`** - -PlaybookRunSystems - -## Table of contents - -### Properties - -- [playbook\_run\_executor\_id](PlaybookRunSystems.md#playbook_run_executor_id) -- [status](PlaybookRunSystems.md#status) -- [system\_id](PlaybookRunSystems.md#system_id) -- [system\_name](PlaybookRunSystems.md#system_name) -- [updated\_at](PlaybookRunSystems.md#updated_at) - -## Properties - -### playbook\_run\_executor\_id - -• **playbook\_run\_executor\_id**: `string` - -**`Memberof`** - -PlaybookRunSystems - -#### Defined in - -[api.ts:623](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L623) - -___ - -### status - -• **status**: [`PlaybookRunSystemStatus`](../enums/PlaybookRunSystemStatus.md) - -**`Memberof`** - -PlaybookRunSystems - -#### Defined in - -[api.ts:611](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L611) - -___ - -### system\_id - -• **system\_id**: `string` - -**`Memberof`** - -PlaybookRunSystems - -#### Defined in - -[api.ts:599](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L599) - -___ - -### system\_name - -• **system\_name**: `string` - -**`Memberof`** - -PlaybookRunSystems - -#### Defined in - -[api.ts:605](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L605) - -___ - -### updated\_at - -• **updated\_at**: `string` - -**`Memberof`** - -PlaybookRunSystems - -#### Defined in - -[api.ts:617](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L617) diff --git a/packages/remediations/doc/interfaces/PlaybookRunsInput.md b/packages/remediations/doc/interfaces/PlaybookRunsInput.md deleted file mode 100644 index 49061dc6f..000000000 --- a/packages/remediations/doc/interfaces/PlaybookRunsInput.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / PlaybookRunsInput - -# Interface: PlaybookRunsInput - -**`Export`** - -PlaybookRunsInput - -## Table of contents - -### Properties - -- [exclude](PlaybookRunsInput.md#exclude) - -## Properties - -### exclude - -• `Optional` **exclude**: `string`[] - -**`Memberof`** - -PlaybookRunsInput - -#### Defined in - -[api.ts:636](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L636) diff --git a/packages/remediations/doc/interfaces/PlaybookRunsList.md b/packages/remediations/doc/interfaces/PlaybookRunsList.md deleted file mode 100644 index 92bd368a7..000000000 --- a/packages/remediations/doc/interfaces/PlaybookRunsList.md +++ /dev/null @@ -1,42 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / PlaybookRunsList - -# Interface: PlaybookRunsList - -**`Export`** - -PlaybookRunsList - -## Table of contents - -### Properties - -- [data](PlaybookRunsList.md#data) -- [meta](PlaybookRunsList.md#meta) - -## Properties - -### data - -• **data**: [`PlaybookRunDetails`](PlaybookRunDetails.md)[] - -**`Memberof`** - -PlaybookRunsList - -#### Defined in - -[api.ts:649](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L649) - -___ - -### meta - -• **meta**: [`Meta`](Meta.md) - -**`Memberof`** - -PlaybookRunsList - -#### Defined in - -[api.ts:655](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L655) diff --git a/packages/remediations/doc/interfaces/RemediationConnectionStatus.md b/packages/remediations/doc/interfaces/RemediationConnectionStatus.md deleted file mode 100644 index 5eae0a8e9..000000000 --- a/packages/remediations/doc/interfaces/RemediationConnectionStatus.md +++ /dev/null @@ -1,42 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / RemediationConnectionStatus - -# Interface: RemediationConnectionStatus - -**`Export`** - -RemediationConnectionStatus - -## Table of contents - -### Properties - -- [data](RemediationConnectionStatus.md#data) -- [meta](RemediationConnectionStatus.md#meta) - -## Properties - -### data - -• **data**: [`PlaybookExecutorStatus`](PlaybookExecutorStatus.md)[] - -**`Memberof`** - -RemediationConnectionStatus - -#### Defined in - -[api.ts:674](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L674) - -___ - -### meta - -• **meta**: [`Meta`](Meta.md) - -**`Memberof`** - -RemediationConnectionStatus - -#### Defined in - -[api.ts:668](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L668) diff --git a/packages/remediations/doc/interfaces/RemediationCreated.md b/packages/remediations/doc/interfaces/RemediationCreated.md deleted file mode 100644 index 0fdad7f0c..000000000 --- a/packages/remediations/doc/interfaces/RemediationCreated.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / RemediationCreated - -# Interface: RemediationCreated - -**`Export`** - -RemediationCreated - -## Table of contents - -### Properties - -- [id](RemediationCreated.md#id) - -## Properties - -### id - -• **id**: `string` - -**`Memberof`** - -RemediationCreated - -#### Defined in - -[api.ts:687](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L687) diff --git a/packages/remediations/doc/interfaces/RemediationDetails.md b/packages/remediations/doc/interfaces/RemediationDetails.md deleted file mode 100644 index 4c6fa1d67..000000000 --- a/packages/remediations/doc/interfaces/RemediationDetails.md +++ /dev/null @@ -1,183 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / RemediationDetails - -# Interface: RemediationDetails - -**`Export`** - -RemediationDetails - -## Table of contents - -### Properties - -- [archived](RemediationDetails.md#archived) -- [auto\_reboot](RemediationDetails.md#auto_reboot) -- [created\_at](RemediationDetails.md#created_at) -- [created\_by](RemediationDetails.md#created_by) -- [id](RemediationDetails.md#id) -- [issues](RemediationDetails.md#issues) -- [name](RemediationDetails.md#name) -- [needs\_reboot](RemediationDetails.md#needs_reboot) -- [resolved\_count](RemediationDetails.md#resolved_count) -- [updated\_at](RemediationDetails.md#updated_at) -- [updated\_by](RemediationDetails.md#updated_by) - -## Properties - -### archived - -• **archived**: `boolean` - -Indicates whether a remediation has been marked as archived - -**`Memberof`** - -RemediationDetails - -#### Defined in - -[api.ts:718](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L718) - -___ - -### auto\_reboot - -• **auto\_reboot**: `boolean` - -Indicates whether systems that require reboot for the remediation to be properly applied should be rebooted automatically or not - -**`Memberof`** - -RemediationDetails - -#### Defined in - -[api.ts:724](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L724) - -___ - -### created\_at - -• **created\_at**: `string` - -**`Memberof`** - -RemediationDetails - -#### Defined in - -[api.ts:736](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L736) - -___ - -### created\_by - -• **created\_by**: [`UserOut`](UserOut.md) - -**`Memberof`** - -RemediationDetails - -#### Defined in - -[api.ts:730](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L730) - -___ - -### id - -• **id**: `string` - -**`Memberof`** - -RemediationDetails - -#### Defined in - -[api.ts:700](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L700) - -___ - -### issues - -• **issues**: [`RemediationIssue`](RemediationIssue.md)[] - -**`Memberof`** - -RemediationDetails - -#### Defined in - -[api.ts:760](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L760) - -___ - -### name - -• **name**: `string` - -**`Memberof`** - -RemediationDetails - -#### Defined in - -[api.ts:706](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L706) - -___ - -### needs\_reboot - -• **needs\_reboot**: `boolean` - -Indicates whether any of the issues contained in the remediation require system reboot - -**`Memberof`** - -RemediationDetails - -#### Defined in - -[api.ts:712](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L712) - -___ - -### resolved\_count - -• **resolved\_count**: `number` - -**`Memberof`** - -RemediationDetails - -#### Defined in - -[api.ts:754](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L754) - -___ - -### updated\_at - -• **updated\_at**: `string` - -**`Memberof`** - -RemediationDetails - -#### Defined in - -[api.ts:748](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L748) - -___ - -### updated\_by - -• **updated\_by**: [`UserOut`](UserOut.md) - -**`Memberof`** - -RemediationDetails - -#### Defined in - -[api.ts:742](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L742) diff --git a/packages/remediations/doc/interfaces/RemediationInput.md b/packages/remediations/doc/interfaces/RemediationInput.md deleted file mode 100644 index 8253ecc7d..000000000 --- a/packages/remediations/doc/interfaces/RemediationInput.md +++ /dev/null @@ -1,76 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / RemediationInput - -# Interface: RemediationInput - -**`Export`** - -RemediationInput - -## Table of contents - -### Properties - -- [add](RemediationInput.md#add) -- [archived](RemediationInput.md#archived) -- [auto\_reboot](RemediationInput.md#auto_reboot) -- [name](RemediationInput.md#name) - -## Properties - -### add - -• `Optional` **add**: [`RemediationInputAdd`](RemediationInputAdd.md) - -**`Memberof`** - -RemediationInput - -#### Defined in - -[api.ts:791](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L791) - -___ - -### archived - -• `Optional` **archived**: `boolean` - -Indicates whether a remediation has been marked as archived - -**`Memberof`** - -RemediationInput - -#### Defined in - -[api.ts:779](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L779) - -___ - -### auto\_reboot - -• `Optional` **auto\_reboot**: `boolean` - -Indicates whether systems that require reboot for the remediation to be properly applied should be rebooted automatically or not - -**`Memberof`** - -RemediationInput - -#### Defined in - -[api.ts:785](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L785) - -___ - -### name - -• `Optional` **name**: `string` - -**`Memberof`** - -RemediationInput - -#### Defined in - -[api.ts:773](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L773) diff --git a/packages/remediations/doc/interfaces/RemediationInputAdd.md b/packages/remediations/doc/interfaces/RemediationInputAdd.md deleted file mode 100644 index 35a73deea..000000000 --- a/packages/remediations/doc/interfaces/RemediationInputAdd.md +++ /dev/null @@ -1,42 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / RemediationInputAdd - -# Interface: RemediationInputAdd - -**`Export`** - -RemediationInputAdd - -## Table of contents - -### Properties - -- [issues](RemediationInputAdd.md#issues) -- [systems](RemediationInputAdd.md#systems) - -## Properties - -### issues - -• **issues**: [`RemediationInputAddIssues`](RemediationInputAddIssues.md)[] - -**`Memberof`** - -RemediationInputAdd - -#### Defined in - -[api.ts:804](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L804) - -___ - -### systems - -• `Optional` **systems**: `string`[] - -**`Memberof`** - -RemediationInputAdd - -#### Defined in - -[api.ts:810](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L810) diff --git a/packages/remediations/doc/interfaces/RemediationInputAddIssues.md b/packages/remediations/doc/interfaces/RemediationInputAddIssues.md deleted file mode 100644 index 4508fd8a5..000000000 --- a/packages/remediations/doc/interfaces/RemediationInputAddIssues.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / RemediationInputAddIssues - -# Interface: RemediationInputAddIssues - -**`Export`** - -RemediationInputAddIssues - -## Table of contents - -### Properties - -- [id](RemediationInputAddIssues.md#id) -- [resolution](RemediationInputAddIssues.md#resolution) -- [systems](RemediationInputAddIssues.md#systems) - -## Properties - -### id - -• **id**: `string` - -**`Memberof`** - -RemediationInputAddIssues - -#### Defined in - -[api.ts:823](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L823) - -___ - -### resolution - -• `Optional` **resolution**: `string` - -**`Memberof`** - -RemediationInputAddIssues - -#### Defined in - -[api.ts:829](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L829) - -___ - -### systems - -• `Optional` **systems**: `string`[] - -**`Memberof`** - -RemediationInputAddIssues - -#### Defined in - -[api.ts:835](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L835) diff --git a/packages/remediations/doc/interfaces/RemediationIssue.md b/packages/remediations/doc/interfaces/RemediationIssue.md deleted file mode 100644 index f22dc7778..000000000 --- a/packages/remediations/doc/interfaces/RemediationIssue.md +++ /dev/null @@ -1,89 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / RemediationIssue - -# Interface: RemediationIssue - -**`Export`** - -RemediationIssue - -## Table of contents - -### Properties - -- [description](RemediationIssue.md#description) -- [id](RemediationIssue.md#id) -- [resolution](RemediationIssue.md#resolution) -- [resolutions\_available](RemediationIssue.md#resolutions_available) -- [systems](RemediationIssue.md#systems) - -## Properties - -### description - -• **description**: `string` - -**`Memberof`** - -RemediationIssue - -#### Defined in - -[api.ts:854](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L854) - -___ - -### id - -• **id**: `string` - -**`Memberof`** - -RemediationIssue - -#### Defined in - -[api.ts:848](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L848) - -___ - -### resolution - -• **resolution**: [`RemediationIssueResolution`](RemediationIssueResolution.md) - -**`Memberof`** - -RemediationIssue - -#### Defined in - -[api.ts:860](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L860) - -___ - -### resolutions\_available - -• `Optional` **resolutions\_available**: `number` - -The total number of available resolutions for this issue - -**`Memberof`** - -RemediationIssue - -#### Defined in - -[api.ts:866](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L866) - -___ - -### systems - -• **systems**: [`SystemOut`](SystemOut.md)[] - -**`Memberof`** - -RemediationIssue - -#### Defined in - -[api.ts:872](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L872) diff --git a/packages/remediations/doc/interfaces/RemediationIssueIn.md b/packages/remediations/doc/interfaces/RemediationIssueIn.md deleted file mode 100644 index d0692ba35..000000000 --- a/packages/remediations/doc/interfaces/RemediationIssueIn.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / RemediationIssueIn - -# Interface: RemediationIssueIn - -**`Export`** - -RemediationIssueIn - -## Table of contents - -### Properties - -- [resolution](RemediationIssueIn.md#resolution) - -## Properties - -### resolution - -• **resolution**: `string` - -**`Memberof`** - -RemediationIssueIn - -#### Defined in - -[api.ts:885](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L885) diff --git a/packages/remediations/doc/interfaces/RemediationIssueResolution.md b/packages/remediations/doc/interfaces/RemediationIssueResolution.md deleted file mode 100644 index e99fa1dad..000000000 --- a/packages/remediations/doc/interfaces/RemediationIssueResolution.md +++ /dev/null @@ -1,74 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / RemediationIssueResolution - -# Interface: RemediationIssueResolution - -**`Export`** - -RemediationIssueResolution - -## Table of contents - -### Properties - -- [description](RemediationIssueResolution.md#description) -- [id](RemediationIssueResolution.md#id) -- [needs\_reboot](RemediationIssueResolution.md#needs_reboot) -- [resolution\_risk](RemediationIssueResolution.md#resolution_risk) - -## Properties - -### description - -• **description**: `string` - -**`Memberof`** - -RemediationIssueResolution - -#### Defined in - -[api.ts:904](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L904) - -___ - -### id - -• **id**: `string` - -**`Memberof`** - -RemediationIssueResolution - -#### Defined in - -[api.ts:898](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L898) - -___ - -### needs\_reboot - -• **needs\_reboot**: `boolean` - -Indicates whether the given resolution involves system reboot - -**`Memberof`** - -RemediationIssueResolution - -#### Defined in - -[api.ts:916](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L916) - -___ - -### resolution\_risk - -• **resolution\_risk**: [`ResolutionRisk`](../enums/ResolutionRisk.md) - -**`Memberof`** - -RemediationIssueResolution - -#### Defined in - -[api.ts:910](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L910) diff --git a/packages/remediations/doc/interfaces/RemediationIssueSystemList.md b/packages/remediations/doc/interfaces/RemediationIssueSystemList.md deleted file mode 100644 index ab90a5d47..000000000 --- a/packages/remediations/doc/interfaces/RemediationIssueSystemList.md +++ /dev/null @@ -1,42 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / RemediationIssueSystemList - -# Interface: RemediationIssueSystemList - -**`Export`** - -RemediationIssueSystemList - -## Table of contents - -### Properties - -- [data](RemediationIssueSystemList.md#data) -- [meta](RemediationIssueSystemList.md#meta) - -## Properties - -### data - -• **data**: [`SystemOut`](SystemOut.md)[] - -**`Memberof`** - -RemediationIssueSystemList - -#### Defined in - -[api.ts:929](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L929) - -___ - -### meta - -• **meta**: [`Meta`](Meta.md) - -**`Memberof`** - -RemediationIssueSystemList - -#### Defined in - -[api.ts:935](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L935) diff --git a/packages/remediations/doc/interfaces/RemediationList.md b/packages/remediations/doc/interfaces/RemediationList.md deleted file mode 100644 index c7e11c158..000000000 --- a/packages/remediations/doc/interfaces/RemediationList.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / RemediationList - -# Interface: RemediationList - -**`Export`** - -RemediationList - -## Table of contents - -### Properties - -- [data](RemediationList.md#data) -- [links](RemediationList.md#links) -- [meta](RemediationList.md#meta) - -## Properties - -### data - -• **data**: [`RemediationListItem`](RemediationListItem.md)[] - -**`Memberof`** - -RemediationList - -#### Defined in - -[api.ts:948](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L948) - -___ - -### links - -• **links**: [`RemediationListLinks`](RemediationListLinks.md) - -**`Memberof`** - -RemediationList - -#### Defined in - -[api.ts:960](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L960) - -___ - -### meta - -• **meta**: [`Meta`](Meta.md) - -**`Memberof`** - -RemediationList - -#### Defined in - -[api.ts:954](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L954) diff --git a/packages/remediations/doc/interfaces/RemediationListItem.md b/packages/remediations/doc/interfaces/RemediationListItem.md deleted file mode 100644 index a8d7c9b4a..000000000 --- a/packages/remediations/doc/interfaces/RemediationListItem.md +++ /dev/null @@ -1,196 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / RemediationListItem - -# Interface: RemediationListItem - -**`Export`** - -RemediationListItem - -## Table of contents - -### Properties - -- [archived](RemediationListItem.md#archived) -- [created\_at](RemediationListItem.md#created_at) -- [created\_by](RemediationListItem.md#created_by) -- [id](RemediationListItem.md#id) -- [issue\_count](RemediationListItem.md#issue_count) -- [name](RemediationListItem.md#name) -- [needs\_reboot](RemediationListItem.md#needs_reboot) -- [playbook\_runs](RemediationListItem.md#playbook_runs) -- [resolved\_count](RemediationListItem.md#resolved_count) -- [system\_count](RemediationListItem.md#system_count) -- [updated\_at](RemediationListItem.md#updated_at) -- [updated\_by](RemediationListItem.md#updated_by) - -## Properties - -### archived - -• **archived**: `boolean` - -Indicates whether a remediation has been marked as archived - -**`Memberof`** - -RemediationListItem - -#### Defined in - -[api.ts:1033](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1033) - -___ - -### created\_at - -• **created\_at**: `string` - -**`Memberof`** - -RemediationListItem - -#### Defined in - -[api.ts:991](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L991) - -___ - -### created\_by - -• **created\_by**: [`UserOut`](UserOut.md) - -**`Memberof`** - -RemediationListItem - -#### Defined in - -[api.ts:985](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L985) - -___ - -### id - -• **id**: `string` - -**`Memberof`** - -RemediationListItem - -#### Defined in - -[api.ts:973](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L973) - -___ - -### issue\_count - -• **issue\_count**: `number` - -**`Memberof`** - -RemediationListItem - -#### Defined in - -[api.ts:1009](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1009) - -___ - -### name - -• **name**: `string` - -**`Memberof`** - -RemediationListItem - -#### Defined in - -[api.ts:979](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L979) - -___ - -### needs\_reboot - -• **needs\_reboot**: `boolean` - -Indicates whether any of the issues contained in the remediation require system reboot - -**`Memberof`** - -RemediationListItem - -#### Defined in - -[api.ts:1027](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1027) - -___ - -### playbook\_runs - -• `Optional` **playbook\_runs**: [`PlaybookRunDetails`](PlaybookRunDetails.md)[] - -**`Memberof`** - -RemediationListItem - -#### Defined in - -[api.ts:1039](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1039) - -___ - -### resolved\_count - -• **resolved\_count**: `number` - -**`Memberof`** - -RemediationListItem - -#### Defined in - -[api.ts:1021](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1021) - -___ - -### system\_count - -• **system\_count**: `number` - -**`Memberof`** - -RemediationListItem - -#### Defined in - -[api.ts:1015](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1015) - -___ - -### updated\_at - -• **updated\_at**: `string` - -**`Memberof`** - -RemediationListItem - -#### Defined in - -[api.ts:1003](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1003) - -___ - -### updated\_by - -• **updated\_by**: [`UserOut`](UserOut.md) - -**`Memberof`** - -RemediationListItem - -#### Defined in - -[api.ts:997](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L997) diff --git a/packages/remediations/doc/interfaces/RemediationListLinks.md b/packages/remediations/doc/interfaces/RemediationListLinks.md deleted file mode 100644 index b450ac4e2..000000000 --- a/packages/remediations/doc/interfaces/RemediationListLinks.md +++ /dev/null @@ -1,80 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / RemediationListLinks - -# Interface: RemediationListLinks - -**`Export`** - -RemediationListLinks - -## Table of contents - -### Properties - -- [first](RemediationListLinks.md#first) -- [last](RemediationListLinks.md#last) -- [next](RemediationListLinks.md#next) -- [previous](RemediationListLinks.md#previous) - -## Properties - -### first - -• **first**: `string` - -relative link to the first page of the query results - -**`Memberof`** - -RemediationListLinks - -#### Defined in - -[api.ts:1052](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1052) - -___ - -### last - -• **last**: `string` - -relative link to the last page of the query results - -**`Memberof`** - -RemediationListLinks - -#### Defined in - -[api.ts:1058](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1058) - -___ - -### next - -• **next**: ``null`` \| `string` - -relative link to the next page of the query results (or null if this is the last page) - -**`Memberof`** - -RemediationListLinks - -#### Defined in - -[api.ts:1064](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1064) - -___ - -### previous - -• **previous**: ``null`` \| `string` - -relative link to the previous page of the query results (or null if this is the first page) - -**`Memberof`** - -RemediationListLinks - -#### Defined in - -[api.ts:1070](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1070) diff --git a/packages/remediations/doc/interfaces/RemediationNameList.md b/packages/remediations/doc/interfaces/RemediationNameList.md deleted file mode 100644 index f1834d64f..000000000 --- a/packages/remediations/doc/interfaces/RemediationNameList.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / RemediationNameList - -# Interface: RemediationNameList - -**`Export`** - -RemediationNameList - -## Table of contents - -### Properties - -- [data](RemediationNameList.md#data) -- [links](RemediationNameList.md#links) -- [meta](RemediationNameList.md#meta) - -## Properties - -### data - -• **data**: [`RemediationNameListItem`](RemediationNameListItem.md)[] - -**`Memberof`** - -RemediationNameList - -#### Defined in - -[api.ts:1083](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1083) - -___ - -### links - -• **links**: [`RemediationListLinks`](RemediationListLinks.md) - -**`Memberof`** - -RemediationNameList - -#### Defined in - -[api.ts:1095](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1095) - -___ - -### meta - -• **meta**: [`Meta`](Meta.md) - -**`Memberof`** - -RemediationNameList - -#### Defined in - -[api.ts:1089](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1089) diff --git a/packages/remediations/doc/interfaces/RemediationNameListItem.md b/packages/remediations/doc/interfaces/RemediationNameListItem.md deleted file mode 100644 index bfd7c99c0..000000000 --- a/packages/remediations/doc/interfaces/RemediationNameListItem.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / RemediationNameListItem - -# Interface: RemediationNameListItem - -**`Export`** - -RemediationNameListItem - -## Table of contents - -### Properties - -- [name](RemediationNameListItem.md#name) - -## Properties - -### name - -• **name**: `string` - -**`Memberof`** - -RemediationNameListItem - -#### Defined in - -[api.ts:1108](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1108) diff --git a/packages/remediations/doc/interfaces/RemediationsList.md b/packages/remediations/doc/interfaces/RemediationsList.md deleted file mode 100644 index 48d77b193..000000000 --- a/packages/remediations/doc/interfaces/RemediationsList.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / RemediationsList - -# Interface: RemediationsList - -**`Export`** - -RemediationsList - -## Table of contents - -### Properties - -- [remediation\_ids](RemediationsList.md#remediation_ids) - -## Properties - -### remediation\_ids - -• **remediation\_ids**: `string`[] - -**`Memberof`** - -RemediationsList - -#### Defined in - -[api.ts:1121](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1121) diff --git a/packages/remediations/doc/interfaces/RequestError.md b/packages/remediations/doc/interfaces/RequestError.md deleted file mode 100644 index df8166097..000000000 --- a/packages/remediations/doc/interfaces/RequestError.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / RequestError - -# Interface: RequestError - -**`Export`** - -RequestError - -## Table of contents - -### Properties - -- [errors](RequestError.md#errors) - -## Properties - -### errors - -• **errors**: [`RequestErrorErrors`](RequestErrorErrors.md)[] - -**`Memberof`** - -RequestError - -#### Defined in - -[api.ts:1134](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1134) diff --git a/packages/remediations/doc/interfaces/RequestErrorErrors.md b/packages/remediations/doc/interfaces/RequestErrorErrors.md deleted file mode 100644 index 5569b107c..000000000 --- a/packages/remediations/doc/interfaces/RequestErrorErrors.md +++ /dev/null @@ -1,87 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / RequestErrorErrors - -# Interface: RequestErrorErrors - -**`Export`** - -RequestErrorErrors - -## Table of contents - -### Properties - -- [code](RequestErrorErrors.md#code) -- [details](RequestErrorErrors.md#details) -- [id](RequestErrorErrors.md#id) -- [status](RequestErrorErrors.md#status) -- [title](RequestErrorErrors.md#title) - -## Properties - -### code - -• **code**: `string` - -**`Memberof`** - -RequestErrorErrors - -#### Defined in - -[api.ts:1159](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1159) - -___ - -### details - -• `Optional` **details**: `object` - -**`Memberof`** - -RequestErrorErrors - -#### Defined in - -[api.ts:1171](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1171) - -___ - -### id - -• **id**: `string` - -**`Memberof`** - -RequestErrorErrors - -#### Defined in - -[api.ts:1147](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1147) - -___ - -### status - -• **status**: `number` - -**`Memberof`** - -RequestErrorErrors - -#### Defined in - -[api.ts:1153](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1153) - -___ - -### title - -• **title**: `string` - -**`Memberof`** - -RequestErrorErrors - -#### Defined in - -[api.ts:1165](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1165) diff --git a/packages/remediations/doc/interfaces/Resolutions.md b/packages/remediations/doc/interfaces/Resolutions.md deleted file mode 100644 index 70396ecdc..000000000 --- a/packages/remediations/doc/interfaces/Resolutions.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / Resolutions - -# Interface: Resolutions - -**`Export`** - -Resolutions - -## Table of contents - -### Properties - -- [id](Resolutions.md#id) -- [resolution\_risk](Resolutions.md#resolution_risk) -- [resolutions](Resolutions.md#resolutions) - -## Properties - -### id - -• **id**: `string` - -**`Memberof`** - -Resolutions - -#### Defined in - -[api.ts:1197](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1197) - -___ - -### resolution\_risk - -• **resolution\_risk**: [`ResolutionRisk`](../enums/ResolutionRisk.md) - -**`Memberof`** - -Resolutions - -#### Defined in - -[api.ts:1203](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1203) - -___ - -### resolutions - -• **resolutions**: [`ResolutionsResolutions`](ResolutionsResolutions.md)[] - -**`Memberof`** - -Resolutions - -#### Defined in - -[api.ts:1209](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1209) diff --git a/packages/remediations/doc/interfaces/ResolutionsBatchInput.md b/packages/remediations/doc/interfaces/ResolutionsBatchInput.md deleted file mode 100644 index 1349f8efb..000000000 --- a/packages/remediations/doc/interfaces/ResolutionsBatchInput.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / ResolutionsBatchInput - -# Interface: ResolutionsBatchInput - -**`Export`** - -ResolutionsBatchInput - -## Table of contents - -### Properties - -- [issues](ResolutionsBatchInput.md#issues) - -## Properties - -### issues - -• **issues**: `string`[] - -**`Memberof`** - -ResolutionsBatchInput - -#### Defined in - -[api.ts:1222](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1222) diff --git a/packages/remediations/doc/interfaces/ResolutionsResolutions.md b/packages/remediations/doc/interfaces/ResolutionsResolutions.md deleted file mode 100644 index f660ab998..000000000 --- a/packages/remediations/doc/interfaces/ResolutionsResolutions.md +++ /dev/null @@ -1,74 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / ResolutionsResolutions - -# Interface: ResolutionsResolutions - -**`Export`** - -ResolutionsResolutions - -## Table of contents - -### Properties - -- [description](ResolutionsResolutions.md#description) -- [id](ResolutionsResolutions.md#id) -- [needs\_reboot](ResolutionsResolutions.md#needs_reboot) -- [resolution\_risk](ResolutionsResolutions.md#resolution_risk) - -## Properties - -### description - -• **description**: `string` - -**`Memberof`** - -ResolutionsResolutions - -#### Defined in - -[api.ts:1241](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1241) - -___ - -### id - -• **id**: `string` - -**`Memberof`** - -ResolutionsResolutions - -#### Defined in - -[api.ts:1235](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1235) - -___ - -### needs\_reboot - -• **needs\_reboot**: `boolean` - -Indicates whether the given resolution involves system reboot - -**`Memberof`** - -ResolutionsResolutions - -#### Defined in - -[api.ts:1247](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1247) - -___ - -### resolution\_risk - -• **resolution\_risk**: [`ResolutionRisk`](../enums/ResolutionRisk.md) - -**`Memberof`** - -ResolutionsResolutions - -#### Defined in - -[api.ts:1253](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1253) diff --git a/packages/remediations/doc/interfaces/SystemOut.md b/packages/remediations/doc/interfaces/SystemOut.md deleted file mode 100644 index 51809aaba..000000000 --- a/packages/remediations/doc/interfaces/SystemOut.md +++ /dev/null @@ -1,72 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / SystemOut - -# Interface: SystemOut - -**`Export`** - -SystemOut - -## Table of contents - -### Properties - -- [display\_name](SystemOut.md#display_name) -- [hostname](SystemOut.md#hostname) -- [id](SystemOut.md#id) -- [resolved](SystemOut.md#resolved) - -## Properties - -### display\_name - -• **display\_name**: ``null`` \| `string` - -**`Memberof`** - -SystemOut - -#### Defined in - -[api.ts:1278](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1278) - -___ - -### hostname - -• **hostname**: ``null`` \| `string` - -**`Memberof`** - -SystemOut - -#### Defined in - -[api.ts:1272](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1272) - -___ - -### id - -• **id**: `string` - -**`Memberof`** - -SystemOut - -#### Defined in - -[api.ts:1266](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1266) - -___ - -### resolved - -• `Optional` **resolved**: `boolean` - -**`Memberof`** - -SystemOut - -#### Defined in - -[api.ts:1284](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1284) diff --git a/packages/remediations/doc/interfaces/UserOut.md b/packages/remediations/doc/interfaces/UserOut.md deleted file mode 100644 index c3806276e..000000000 --- a/packages/remediations/doc/interfaces/UserOut.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/remediations-client](../README.md) / [Exports](../modules.md) / UserOut - -# Interface: UserOut - -**`Export`** - -UserOut - -## Table of contents - -### Properties - -- [first\_name](UserOut.md#first_name) -- [last\_name](UserOut.md#last_name) -- [username](UserOut.md#username) - -## Properties - -### first\_name - -• `Optional` **first\_name**: `string` - -**`Memberof`** - -UserOut - -#### Defined in - -[api.ts:1303](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1303) - -___ - -### last\_name - -• `Optional` **last\_name**: `string` - -**`Memberof`** - -UserOut - -#### Defined in - -[api.ts:1309](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1309) - -___ - -### username - -• **username**: `string` - -**`Memberof`** - -UserOut - -#### Defined in - -[api.ts:1297](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1297) diff --git a/packages/remediations/doc/modules.md b/packages/remediations/doc/modules.md deleted file mode 100644 index bdf4e34da..000000000 --- a/packages/remediations/doc/modules.md +++ /dev/null @@ -1,580 +0,0 @@ -[@redhat-cloud-services/remediations-client](README.md) / Exports - -# @redhat-cloud-services/remediations-client - -## Table of contents - -### Enumerations - -- [PlaybookExecutorStatusConnectionStatusEnum](enums/PlaybookExecutorStatusConnectionStatusEnum.md) -- [PlaybookRunExecutorStatus](enums/PlaybookRunExecutorStatus.md) -- [PlaybookRunStatus](enums/PlaybookRunStatus.md) -- [PlaybookRunSystemStatus](enums/PlaybookRunSystemStatus.md) -- [ResolutionRisk](enums/ResolutionRisk.md) - -### Classes - -- [Configuration](classes/Configuration.md) -- [DiagnosisApi](classes/DiagnosisApi.md) -- [GeneratorApi](classes/GeneratorApi.md) -- [RemediationsApi](classes/RemediationsApi.md) -- [ResolutionsApi](classes/ResolutionsApi.md) -- [VersionApi](classes/VersionApi.md) - -### Interfaces - -- [ConfigurationParameters](interfaces/ConfigurationParameters.md) -- [Counts](interfaces/Counts.md) -- [Diagnosis](interfaces/Diagnosis.md) -- [ExecuteRemediation](interfaces/ExecuteRemediation.md) -- [InlineResponse200](interfaces/InlineResponse200.md) -- [Meta](interfaces/Meta.md) -- [MultipleDelete](interfaces/MultipleDelete.md) -- [NoExecutors](interfaces/NoExecutors.md) -- [NoExecutorsErrors](interfaces/NoExecutorsErrors.md) -- [PlaybookDefinition](interfaces/PlaybookDefinition.md) -- [PlaybookDefinitionIssues](interfaces/PlaybookDefinitionIssues.md) -- [PlaybookExecutorDetails](interfaces/PlaybookExecutorDetails.md) -- [PlaybookExecutorStatus](interfaces/PlaybookExecutorStatus.md) -- [PlaybookExecutors](interfaces/PlaybookExecutors.md) -- [PlaybookRunDetails](interfaces/PlaybookRunDetails.md) -- [PlaybookRunExecutorDetails](interfaces/PlaybookRunExecutorDetails.md) -- [PlaybookRunSystemDetails](interfaces/PlaybookRunSystemDetails.md) -- [PlaybookRunSystemList](interfaces/PlaybookRunSystemList.md) -- [PlaybookRunSystems](interfaces/PlaybookRunSystems.md) -- [PlaybookRunsInput](interfaces/PlaybookRunsInput.md) -- [PlaybookRunsList](interfaces/PlaybookRunsList.md) -- [RemediationConnectionStatus](interfaces/RemediationConnectionStatus.md) -- [RemediationCreated](interfaces/RemediationCreated.md) -- [RemediationDetails](interfaces/RemediationDetails.md) -- [RemediationInput](interfaces/RemediationInput.md) -- [RemediationInputAdd](interfaces/RemediationInputAdd.md) -- [RemediationInputAddIssues](interfaces/RemediationInputAddIssues.md) -- [RemediationIssue](interfaces/RemediationIssue.md) -- [RemediationIssueIn](interfaces/RemediationIssueIn.md) -- [RemediationIssueResolution](interfaces/RemediationIssueResolution.md) -- [RemediationIssueSystemList](interfaces/RemediationIssueSystemList.md) -- [RemediationList](interfaces/RemediationList.md) -- [RemediationListItem](interfaces/RemediationListItem.md) -- [RemediationListLinks](interfaces/RemediationListLinks.md) -- [RemediationNameList](interfaces/RemediationNameList.md) -- [RemediationNameListItem](interfaces/RemediationNameListItem.md) -- [RemediationsList](interfaces/RemediationsList.md) -- [RequestError](interfaces/RequestError.md) -- [RequestErrorErrors](interfaces/RequestErrorErrors.md) -- [Resolutions](interfaces/Resolutions.md) -- [ResolutionsBatchInput](interfaces/ResolutionsBatchInput.md) -- [ResolutionsResolutions](interfaces/ResolutionsResolutions.md) -- [SystemOut](interfaces/SystemOut.md) -- [UserOut](interfaces/UserOut.md) - -### Functions - -- [DiagnosisApiAxiosParamCreator](modules.md#diagnosisapiaxiosparamcreator) -- [DiagnosisApiFactory](modules.md#diagnosisapifactory) -- [DiagnosisApiFp](modules.md#diagnosisapifp) -- [GeneratorApiAxiosParamCreator](modules.md#generatorapiaxiosparamcreator) -- [GeneratorApiFactory](modules.md#generatorapifactory) -- [GeneratorApiFp](modules.md#generatorapifp) -- [RemediationsApiAxiosParamCreator](modules.md#remediationsapiaxiosparamcreator) -- [RemediationsApiFactory](modules.md#remediationsapifactory) -- [RemediationsApiFp](modules.md#remediationsapifp) -- [ResolutionsApiAxiosParamCreator](modules.md#resolutionsapiaxiosparamcreator) -- [ResolutionsApiFactory](modules.md#resolutionsapifactory) -- [ResolutionsApiFp](modules.md#resolutionsapifp) -- [VersionApiAxiosParamCreator](modules.md#versionapiaxiosparamcreator) -- [VersionApiFactory](modules.md#versionapifactory) -- [VersionApiFp](modules.md#versionapifp) - -## Functions - -### DiagnosisApiAxiosParamCreator - -▸ **DiagnosisApiAxiosParamCreator**(`configuration?`): `Object` - -DiagnosisApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `getDiagnosis` | (`system`: `string`, `remediation?`: `string`, `branchId?`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:1316](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1316) - -___ - -### DiagnosisApiFactory - -▸ **DiagnosisApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -DiagnosisApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getDiagnosis` | (`system`: `string`, `remediation?`: `string`, `branchId?`: `string`, `options?`: `any`) => `AxiosPromise`\<[`Diagnosis`](interfaces/Diagnosis.md)\> | - -**`Export`** - -#### Defined in - -[api.ts:1396](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1396) - -___ - -### DiagnosisApiFp - -▸ **DiagnosisApiFp**(`configuration?`): `Object` - -DiagnosisApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getDiagnosis` | (`system`: `string`, `remediation?`: `string`, `branchId?`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`Diagnosis`](interfaces/Diagnosis.md)\>\> | - -**`Export`** - -#### Defined in - -[api.ts:1371](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1371) - -___ - -### GeneratorApiAxiosParamCreator - -▸ **GeneratorApiAxiosParamCreator**(`configuration?`): `Object` - -GeneratorApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `generate` | (`playbookDefinition`: [`PlaybookDefinition`](interfaces/PlaybookDefinition.md), `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:1441](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1441) - -___ - -### GeneratorApiFactory - -▸ **GeneratorApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -GeneratorApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `generate` | (`playbookDefinition`: [`PlaybookDefinition`](interfaces/PlaybookDefinition.md), `options?`: `any`) => `AxiosPromise`\<`string`\> | - -**`Export`** - -#### Defined in - -[api.ts:1512](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1512) - -___ - -### GeneratorApiFp - -▸ **GeneratorApiFp**(`configuration?`): `Object` - -GeneratorApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `generate` | (`playbookDefinition`: [`PlaybookDefinition`](interfaces/PlaybookDefinition.md), `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<`string`\>\> | - -**`Export`** - -#### Defined in - -[api.ts:1489](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1489) - -___ - -### RemediationsApiAxiosParamCreator - -▸ **RemediationsApiAxiosParamCreator**(`configuration?`): `Object` - -RemediationsApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `bulkGetRemediationPlaybook` | (`id`: `string`, `requestBody`: `string`[], `satOrg?`: `string`, `localhost?`: `boolean`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `cancelPlaybookRuns` | (`id`: `string`, `playbookRunId`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `checkExecutable` | (`id`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `createRemediation` | (`remediationInput`: [`RemediationInput`](interfaces/RemediationInput.md), `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `deleteRemediation` | (`id`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `deleteRemediationIssue` | (`id`: `string`, `issue`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `deleteRemediationIssueSystem` | (`id`: `string`, `issue`: `string`, `system`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `deleteRemediations` | (`remediationsList`: [`RemediationsList`](interfaces/RemediationsList.md), `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `downloadPlaybooks` | (`selectedRemediations?`: `string`[], `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `getPlaybookRunDetails` | (`id`: `string`, `playbookRunId`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `getPlaybookRunSystemDetails` | (`id`: `string`, `playbookRunId`: `string`, `system`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `getPlaybookRunSystems` | (`id`: `string`, `playbookRunId`: `string`, `executor?`: `string`, `limit?`: `number`, `offset?`: `number`, `ansibleHost?`: `string`, `sort?`: ``"system_name"`` \| ``"-system_name"``, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `getRemediation` | (`id`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `getRemediationConnectionStatus` | (`id`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `getRemediationIssueSystems` | (`id`: `string`, `issue`: `string`, `limit?`: `number`, `offset?`: `number`, `sort?`: ``"display_name"`` \| ``"-display_name"``, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `getRemediationPlaybook` | (`id`: `string`, `hosts?`: `string`[], `satOrg?`: `string`, `localhost?`: `boolean`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `getRemediations` | (`sort?`: ``"updated_at"`` \| ``"-updated_at"`` \| ``"name"`` \| ``"-name"`` \| ``"system_count"`` \| ``"-system_count"`` \| ``"issue_count"`` \| ``"-issue_count"``, `filter?`: `string`, `limit?`: `number`, `offset?`: `number`, `system?`: `string`, `hideArchived?`: `boolean`, `fieldsData?`: (``"name"`` \| ``"playbook_runs"``)[], `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `listPlaybookRuns` | (`id`: `string`, `limit?`: `number`, `offset?`: `number`, `sort?`: ``"updated_at"`` \| ``"-updated_at"``, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `runRemediation` | (`id`: `string`, `playbookRunsInput?`: [`PlaybookRunsInput`](interfaces/PlaybookRunsInput.md), `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `updateRemediation` | (`id`: `string`, `remediationInput`: [`RemediationInput`](interfaces/RemediationInput.md), `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `updateRemediationIssue` | (`id`: `string`, `issue`: `string`, `remediationIssueIn`: [`RemediationIssueIn`](interfaces/RemediationIssueIn.md), `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:1553](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L1553) - -___ - -### RemediationsApiFactory - -▸ **RemediationsApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -RemediationsApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `bulkGetRemediationPlaybook` | (`id`: `string`, `requestBody`: `string`[], `satOrg?`: `string`, `localhost?`: `boolean`, `options?`: `any`) => `AxiosPromise`\<`string`\> | -| `cancelPlaybookRuns` | (`id`: `string`, `playbookRunId`: `string`, `options?`: `any`) => `AxiosPromise`\<`object`\> | -| `checkExecutable` | (`id`: `string`, `options?`: `any`) => `AxiosPromise`\<`void`\> | -| `createRemediation` | (`remediationInput`: [`RemediationInput`](interfaces/RemediationInput.md), `options?`: `any`) => `AxiosPromise`\<[`RemediationCreated`](interfaces/RemediationCreated.md)\> | -| `deleteRemediation` | (`id`: `string`, `options?`: `any`) => `AxiosPromise`\<`void`\> | -| `deleteRemediationIssue` | (`id`: `string`, `issue`: `string`, `options?`: `any`) => `AxiosPromise`\<`void`\> | -| `deleteRemediationIssueSystem` | (`id`: `string`, `issue`: `string`, `system`: `string`, `options?`: `any`) => `AxiosPromise`\<`void`\> | -| `deleteRemediations` | (`remediationsList`: [`RemediationsList`](interfaces/RemediationsList.md), `options?`: `any`) => `AxiosPromise`\<[`MultipleDelete`](interfaces/MultipleDelete.md)\> | -| `downloadPlaybooks` | (`selectedRemediations?`: `string`[], `options?`: `any`) => `AxiosPromise`\<`any`\> | -| `getPlaybookRunDetails` | (`id`: `string`, `playbookRunId`: `string`, `options?`: `any`) => `AxiosPromise`\<[`PlaybookRunExecutorDetails`](interfaces/PlaybookRunExecutorDetails.md)\> | -| `getPlaybookRunSystemDetails` | (`id`: `string`, `playbookRunId`: `string`, `system`: `string`, `options?`: `any`) => `AxiosPromise`\<[`PlaybookRunSystemDetails`](interfaces/PlaybookRunSystemDetails.md)\> | -| `getPlaybookRunSystems` | (`id`: `string`, `playbookRunId`: `string`, `executor?`: `string`, `limit?`: `number`, `offset?`: `number`, `ansibleHost?`: `string`, `sort?`: ``"system_name"`` \| ``"-system_name"``, `options?`: `any`) => `AxiosPromise`\<[`PlaybookRunSystemList`](interfaces/PlaybookRunSystemList.md)\> | -| `getRemediation` | (`id`: `string`, `options?`: `any`) => `AxiosPromise`\<[`RemediationDetails`](interfaces/RemediationDetails.md)\> | -| `getRemediationConnectionStatus` | (`id`: `string`, `options?`: `any`) => `AxiosPromise`\<[`RemediationConnectionStatus`](interfaces/RemediationConnectionStatus.md)\> | -| `getRemediationIssueSystems` | (`id`: `string`, `issue`: `string`, `limit?`: `number`, `offset?`: `number`, `sort?`: ``"display_name"`` \| ``"-display_name"``, `options?`: `any`) => `AxiosPromise`\<[`RemediationIssueSystemList`](interfaces/RemediationIssueSystemList.md)\> | -| `getRemediationPlaybook` | (`id`: `string`, `hosts?`: `string`[], `satOrg?`: `string`, `localhost?`: `boolean`, `options?`: `any`) => `AxiosPromise`\<`string`\> | -| `getRemediations` | (`sort?`: ``"updated_at"`` \| ``"-updated_at"`` \| ``"name"`` \| ``"-name"`` \| ``"system_count"`` \| ``"-system_count"`` \| ``"issue_count"`` \| ``"-issue_count"``, `filter?`: `string`, `limit?`: `number`, `offset?`: `number`, `system?`: `string`, `hideArchived?`: `boolean`, `fieldsData?`: (``"name"`` \| ``"playbook_runs"``)[], `options?`: `any`) => `AxiosPromise`\<[`RemediationList`](interfaces/RemediationList.md) \| [`RemediationNameList`](interfaces/RemediationNameList.md)\> | -| `listPlaybookRuns` | (`id`: `string`, `limit?`: `number`, `offset?`: `number`, `sort?`: ``"updated_at"`` \| ``"-updated_at"``, `options?`: `any`) => `AxiosPromise`\<[`PlaybookRunsList`](interfaces/PlaybookRunsList.md)\> | -| `runRemediation` | (`id`: `string`, `playbookRunsInput?`: [`PlaybookRunsInput`](interfaces/PlaybookRunsInput.md), `options?`: `any`) => `AxiosPromise`\<[`ExecuteRemediation`](interfaces/ExecuteRemediation.md)\> | -| `updateRemediation` | (`id`: `string`, `remediationInput`: [`RemediationInput`](interfaces/RemediationInput.md), `options?`: `any`) => `AxiosPromise`\<`void`\> | -| `updateRemediationIssue` | (`id`: `string`, `issue`: `string`, `remediationIssueIn`: [`RemediationIssueIn`](interfaces/RemediationIssueIn.md), `options?`: `any`) => `AxiosPromise`\<`void`\> | - -**`Export`** - -#### Defined in - -[api.ts:2863](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L2863) - -___ - -### RemediationsApiFp - -▸ **RemediationsApiFp**(`configuration?`): `Object` - -RemediationsApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `bulkGetRemediationPlaybook` | (`id`: `string`, `requestBody`: `string`[], `satOrg?`: `string`, `localhost?`: `boolean`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<`string`\>\> | -| `cancelPlaybookRuns` | (`id`: `string`, `playbookRunId`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<`object`\>\> | -| `checkExecutable` | (`id`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<`void`\>\> | -| `createRemediation` | (`remediationInput`: [`RemediationInput`](interfaces/RemediationInput.md), `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`RemediationCreated`](interfaces/RemediationCreated.md)\>\> | -| `deleteRemediation` | (`id`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<`void`\>\> | -| `deleteRemediationIssue` | (`id`: `string`, `issue`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<`void`\>\> | -| `deleteRemediationIssueSystem` | (`id`: `string`, `issue`: `string`, `system`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<`void`\>\> | -| `deleteRemediations` | (`remediationsList`: [`RemediationsList`](interfaces/RemediationsList.md), `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`MultipleDelete`](interfaces/MultipleDelete.md)\>\> | -| `downloadPlaybooks` | (`selectedRemediations?`: `string`[], `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<`any`\>\> | -| `getPlaybookRunDetails` | (`id`: `string`, `playbookRunId`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`PlaybookRunExecutorDetails`](interfaces/PlaybookRunExecutorDetails.md)\>\> | -| `getPlaybookRunSystemDetails` | (`id`: `string`, `playbookRunId`: `string`, `system`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`PlaybookRunSystemDetails`](interfaces/PlaybookRunSystemDetails.md)\>\> | -| `getPlaybookRunSystems` | (`id`: `string`, `playbookRunId`: `string`, `executor?`: `string`, `limit?`: `number`, `offset?`: `number`, `ansibleHost?`: `string`, `sort?`: ``"system_name"`` \| ``"-system_name"``, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`PlaybookRunSystemList`](interfaces/PlaybookRunSystemList.md)\>\> | -| `getRemediation` | (`id`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`RemediationDetails`](interfaces/RemediationDetails.md)\>\> | -| `getRemediationConnectionStatus` | (`id`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`RemediationConnectionStatus`](interfaces/RemediationConnectionStatus.md)\>\> | -| `getRemediationIssueSystems` | (`id`: `string`, `issue`: `string`, `limit?`: `number`, `offset?`: `number`, `sort?`: ``"display_name"`` \| ``"-display_name"``, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`RemediationIssueSystemList`](interfaces/RemediationIssueSystemList.md)\>\> | -| `getRemediationPlaybook` | (`id`: `string`, `hosts?`: `string`[], `satOrg?`: `string`, `localhost?`: `boolean`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<`string`\>\> | -| `getRemediations` | (`sort?`: ``"updated_at"`` \| ``"-updated_at"`` \| ``"name"`` \| ``"-name"`` \| ``"system_count"`` \| ``"-system_count"`` \| ``"issue_count"`` \| ``"-issue_count"``, `filter?`: `string`, `limit?`: `number`, `offset?`: `number`, `system?`: `string`, `hideArchived?`: `boolean`, `fieldsData?`: (``"name"`` \| ``"playbook_runs"``)[], `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`RemediationList`](interfaces/RemediationList.md) \| [`RemediationNameList`](interfaces/RemediationNameList.md)\>\> | -| `listPlaybookRuns` | (`id`: `string`, `limit?`: `number`, `offset?`: `number`, `sort?`: ``"updated_at"`` \| ``"-updated_at"``, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`PlaybookRunsList`](interfaces/PlaybookRunsList.md)\>\> | -| `runRemediation` | (`id`: `string`, `playbookRunsInput?`: [`PlaybookRunsInput`](interfaces/PlaybookRunsInput.md), `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`ExecuteRemediation`](interfaces/ExecuteRemediation.md)\>\> | -| `updateRemediation` | (`id`: `string`, `remediationInput`: [`RemediationInput`](interfaces/RemediationInput.md), `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<`void`\>\> | -| `updateRemediationIssue` | (`id`: `string`, `issue`: `string`, `remediationIssueIn`: [`RemediationIssueIn`](interfaces/RemediationIssueIn.md), `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<`void`\>\> | - -**`Export`** - -#### Defined in - -[api.ts:2524](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L2524) - -___ - -### ResolutionsApiAxiosParamCreator - -▸ **ResolutionsApiAxiosParamCreator**(`configuration?`): `Object` - -ResolutionsApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `getResolutionsForIssue` | (`issue`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `getResolutionsForIssues` | (`resolutionsBatchInput`: [`ResolutionsBatchInput`](interfaces/ResolutionsBatchInput.md), `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:3416](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3416) - -___ - -### ResolutionsApiFactory - -▸ **ResolutionsApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -ResolutionsApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getResolutionsForIssue` | (`issue`: `string`, `options?`: `any`) => `AxiosPromise`\<[`Resolutions`](interfaces/Resolutions.md)\> | -| `getResolutionsForIssues` | (`resolutionsBatchInput`: [`ResolutionsBatchInput`](interfaces/ResolutionsBatchInput.md), `options?`: `any`) => `AxiosPromise`\<\{ `[key: string]`: [`Resolutions`](interfaces/Resolutions.md) \| `boolean`; }\> | - -**`Export`** - -#### Defined in - -[api.ts:3537](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3537) - -___ - -### ResolutionsApiFp - -▸ **ResolutionsApiFp**(`configuration?`): `Object` - -ResolutionsApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getResolutionsForIssue` | (`issue`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`Resolutions`](interfaces/Resolutions.md)\>\> | -| `getResolutionsForIssues` | (`resolutionsBatchInput`: [`ResolutionsBatchInput`](interfaces/ResolutionsBatchInput.md), `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<\{ `[key: string]`: [`Resolutions`](interfaces/Resolutions.md) \| `boolean`; }\>\> | - -**`Export`** - -#### Defined in - -[api.ts:3500](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3500) - -___ - -### VersionApiAxiosParamCreator - -▸ **VersionApiAxiosParamCreator**(`configuration?`): `Object` - -VersionApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `getVersion` | (`options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:3600](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3600) - -___ - -### VersionApiFactory - -▸ **VersionApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -VersionApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getVersion` | (`options?`: `any`) => `AxiosPromise`\<[`InlineResponse200`](interfaces/InlineResponse200.md)\> | - -**`Export`** - -#### Defined in - -[api.ts:3661](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3661) - -___ - -### VersionApiFp - -▸ **VersionApiFp**(`configuration?`): `Object` - -VersionApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getVersion` | (`options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`InlineResponse200`](interfaces/InlineResponse200.md)\>\> | - -**`Export`** - -#### Defined in - -[api.ts:3639](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/remediations/api.ts#L3639) diff --git a/packages/remediations/jest.config.ts b/packages/remediations/jest.config.ts index 1d96eae53..1e4b8257d 100644 --- a/packages/remediations/jest.config.ts +++ b/packages/remediations/jest.config.ts @@ -7,4 +7,5 @@ export default { }, moduleFileExtensions: ['ts', 'js', 'html'], coverageDirectory: '../../coverage/packages/remediations', + testPathIgnorePatterns: ['/node_modules/','/tests/'], }; diff --git a/packages/remediations/package.json b/packages/remediations/package.json index 0159d8b8b..b94161720 100644 --- a/packages/remediations/package.json +++ b/packages/remediations/package.json @@ -5,32 +5,32 @@ "publishConfig": { "access": "public" }, - "main": "./dist/index.js", - "typings": "./dist/index.d.ts", + "main": "./index.js", + "typings": "./index.d.ts", "exports": { ".": { - "types": "./dist/index.d.ts", - "import": "./dist/esm/index.js", - "default": "./dist/index.js" + "types": "./index.d.ts", + "import": "./esm/index.js", + "default": "./index.js" }, "./api": { - "types": "./dist/api.d.ts", - "import": "./dist/esm/api.js", - "default": "./dist/api.js" + "types": "./api.d.ts", + "import": "./esm/api.js", + "default": "./api.js" }, "./*": { - "types": "./dist/*/index.d.ts", - "import": "./dist/esm/*/index.js", - "default": "./dist/*/index.js" + "types": "./*/index.d.ts", + "import": "./esm/*/index.js", + "default": "./*/index.js" } }, "typesVersions": { "*": { "api": [ - "./dist/api.d.ts" + "./api.d.ts" ], "*": [ - "./dist/*/index.d.ts" + "./*/index.d.ts" ] } }, diff --git a/packages/remediations/project.json b/packages/remediations/project.json index 4e0ef7b4f..1dc74e65f 100644 --- a/packages/remediations/project.json +++ b/packages/remediations/project.json @@ -4,20 +4,30 @@ "sourceRoot": "packages/remediations", "projectType": "library", "targets": { + "clean-generate": { + "command": "rm -rf packages/remediations/src" + }, "generate": { + "dependsOn": ["clean-generate"], "executor": "@redhat-cloud-services/build-utils:client-generator", "options": { + "outputPath": "packages/remediations/src", "specs": { "default": "http://cloud.redhat.com/api/remediations/v1/openapi.json" }, "clientName": "RemediationsClient" } }, + "clean-build": { + "command": "rm -rf packages/remediations/dist" + }, "build": { + "dependsOn": ["clean-build", "^build"], "executor": "@redhat-cloud-services/build-utils:builder", "options": { + "inputPath": "packages/remediations/src", "outputPath": "packages/remediations/dist", - "main": "packages/remediations/index.ts", + "main": "packages/remediations/src/index.ts", "esmTsConfig": "packages/remediations/tsconfig.esm.json", "cjsTsConfig": "packages/remediations/tsconfig.cjs.json" } diff --git a/packages/remediations/src/.gitignore b/packages/remediations/src/.gitignore new file mode 100644 index 000000000..149b57654 --- /dev/null +++ b/packages/remediations/src/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/packages/remediations/src/.npmignore b/packages/remediations/src/.npmignore new file mode 100644 index 000000000..6b112e4e7 --- /dev/null +++ b/packages/remediations/src/.npmignore @@ -0,0 +1,6 @@ +.openapi-generator +node_modules +.openapi-generator-ignore +package-lock.json +*.ts +!*.d.ts diff --git a/packages/remediations/src/.openapi-generator-ignore b/packages/remediations/src/.openapi-generator-ignore new file mode 100644 index 000000000..7484ee590 --- /dev/null +++ b/packages/remediations/src/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/packages/remediations/.openapi-generator/FILES b/packages/remediations/src/.openapi-generator/FILES similarity index 96% rename from packages/remediations/.openapi-generator/FILES rename to packages/remediations/src/.openapi-generator/FILES index 9f4daa8fc..daf113f64 100644 --- a/packages/remediations/.openapi-generator/FILES +++ b/packages/remediations/src/.openapi-generator/FILES @@ -1,4 +1,6 @@ +.gitignore .npmignore +.openapi-generator-ignore BulkGetRemediationPlaybook/index.ts CancelPlaybookRuns/index.ts CheckExecutable/index.ts diff --git a/packages/remediations/.openapi-generator/VERSION b/packages/remediations/src/.openapi-generator/VERSION similarity index 100% rename from packages/remediations/.openapi-generator/VERSION rename to packages/remediations/src/.openapi-generator/VERSION diff --git a/packages/remediations/BulkGetRemediationPlaybook/index.ts b/packages/remediations/src/BulkGetRemediationPlaybook/index.ts similarity index 100% rename from packages/remediations/BulkGetRemediationPlaybook/index.ts rename to packages/remediations/src/BulkGetRemediationPlaybook/index.ts diff --git a/packages/remediations/CancelPlaybookRuns/index.ts b/packages/remediations/src/CancelPlaybookRuns/index.ts similarity index 100% rename from packages/remediations/CancelPlaybookRuns/index.ts rename to packages/remediations/src/CancelPlaybookRuns/index.ts diff --git a/packages/remediations/CheckExecutable/index.ts b/packages/remediations/src/CheckExecutable/index.ts similarity index 95% rename from packages/remediations/CheckExecutable/index.ts rename to packages/remediations/src/CheckExecutable/index.ts index a7554dca2..f57c12b50 100644 --- a/packages/remediations/CheckExecutable/index.ts +++ b/packages/remediations/src/CheckExecutable/index.ts @@ -31,8 +31,8 @@ const isCheckExecutableObjectParams = (params: [CheckExecutableParams] | unknown return false } /** -* Checks remediation for the existence of smart_managment flaged systems -* @summary Check smart_managment systems +* Checks if a remediation exists +* @summary Check if remediation is executable * @param {CheckExecutableParams} config with all available params. * @param {*} [options] Override http request option. * @throws {RequiredError} diff --git a/packages/remediations/CreateRemediation/index.ts b/packages/remediations/src/CreateRemediation/index.ts similarity index 100% rename from packages/remediations/CreateRemediation/index.ts rename to packages/remediations/src/CreateRemediation/index.ts diff --git a/packages/remediations/DeleteRemediation/index.ts b/packages/remediations/src/DeleteRemediation/index.ts similarity index 100% rename from packages/remediations/DeleteRemediation/index.ts rename to packages/remediations/src/DeleteRemediation/index.ts diff --git a/packages/remediations/DeleteRemediationIssue/index.ts b/packages/remediations/src/DeleteRemediationIssue/index.ts similarity index 100% rename from packages/remediations/DeleteRemediationIssue/index.ts rename to packages/remediations/src/DeleteRemediationIssue/index.ts diff --git a/packages/remediations/DeleteRemediationIssueSystem/index.ts b/packages/remediations/src/DeleteRemediationIssueSystem/index.ts similarity index 100% rename from packages/remediations/DeleteRemediationIssueSystem/index.ts rename to packages/remediations/src/DeleteRemediationIssueSystem/index.ts diff --git a/packages/remediations/DeleteRemediationIssues/index.ts b/packages/remediations/src/DeleteRemediationIssues/index.ts similarity index 100% rename from packages/remediations/DeleteRemediationIssues/index.ts rename to packages/remediations/src/DeleteRemediationIssues/index.ts diff --git a/packages/remediations/DeleteRemediationSystem/index.ts b/packages/remediations/src/DeleteRemediationSystem/index.ts similarity index 100% rename from packages/remediations/DeleteRemediationSystem/index.ts rename to packages/remediations/src/DeleteRemediationSystem/index.ts diff --git a/packages/remediations/DeleteRemediationSystems/index.ts b/packages/remediations/src/DeleteRemediationSystems/index.ts similarity index 97% rename from packages/remediations/DeleteRemediationSystems/index.ts rename to packages/remediations/src/DeleteRemediationSystems/index.ts index 9c4a95c3e..591f87be6 100644 --- a/packages/remediations/DeleteRemediationSystems/index.ts +++ b/packages/remediations/src/DeleteRemediationSystems/index.ts @@ -46,7 +46,7 @@ const isDeleteRemediationSystemsObjectParams = (params: [DeleteRemediationSystem export const deleteRemediationSystemsParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([DeleteRemediationSystemsParams] | [string, SystemsList, AxiosRequestConfig])) => { const params = isDeleteRemediationSystemsObjectParams(config) ? config[0] : ['id', 'systemsList', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as DeleteRemediationSystemsParams; const { id, systemsList, options = {} } = params; - const localVarPath = `/remediations/{id}/systems/{system}/issues` + const localVarPath = `/remediations/{id}/systems` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); diff --git a/packages/remediations/DeleteRemediations/index.ts b/packages/remediations/src/DeleteRemediations/index.ts similarity index 100% rename from packages/remediations/DeleteRemediations/index.ts rename to packages/remediations/src/DeleteRemediations/index.ts diff --git a/packages/remediations/DownloadPlaybooks/index.ts b/packages/remediations/src/DownloadPlaybooks/index.ts similarity index 100% rename from packages/remediations/DownloadPlaybooks/index.ts rename to packages/remediations/src/DownloadPlaybooks/index.ts diff --git a/packages/remediations/Generate/index.ts b/packages/remediations/src/Generate/index.ts similarity index 100% rename from packages/remediations/Generate/index.ts rename to packages/remediations/src/Generate/index.ts diff --git a/packages/remediations/GetDiagnosis/index.ts b/packages/remediations/src/GetDiagnosis/index.ts similarity index 100% rename from packages/remediations/GetDiagnosis/index.ts rename to packages/remediations/src/GetDiagnosis/index.ts diff --git a/packages/remediations/GetPlaybookRunDetails/index.ts b/packages/remediations/src/GetPlaybookRunDetails/index.ts similarity index 100% rename from packages/remediations/GetPlaybookRunDetails/index.ts rename to packages/remediations/src/GetPlaybookRunDetails/index.ts diff --git a/packages/remediations/GetPlaybookRunSystemDetails/index.ts b/packages/remediations/src/GetPlaybookRunSystemDetails/index.ts similarity index 100% rename from packages/remediations/GetPlaybookRunSystemDetails/index.ts rename to packages/remediations/src/GetPlaybookRunSystemDetails/index.ts diff --git a/packages/remediations/GetPlaybookRunSystems/index.ts b/packages/remediations/src/GetPlaybookRunSystems/index.ts similarity index 100% rename from packages/remediations/GetPlaybookRunSystems/index.ts rename to packages/remediations/src/GetPlaybookRunSystems/index.ts diff --git a/packages/remediations/GetRemediation/index.ts b/packages/remediations/src/GetRemediation/index.ts similarity index 93% rename from packages/remediations/GetRemediation/index.ts rename to packages/remediations/src/GetRemediation/index.ts index c54a0fa08..8c2ae4b36 100644 --- a/packages/remediations/GetRemediation/index.ts +++ b/packages/remediations/src/GetRemediation/index.ts @@ -19,7 +19,7 @@ export type GetRemediationParams = { */ id: string, /** - * Optional format for returned data. `\'summary\'` format returns counts instead of issue and system details, e.g.: ``` { \"id\": \"9197ba55-0abc-4028-9bbe-269e530f8bd5\", \"name\": \"Fix Critical CVEs\", \"archived\": true, \"auto_reboot\": true, \"created_at\": \"2018-12-05T08:19:36.641Z\", \"created_by\": { \"username\": \"jharting@redhat.com\", \"first_name\": \"Jozef\", \"last_name\": \"Hartinger\" }, \"updated_at\": \"2018-12-05T08:19:36.641Z\", \"updated_by\": { \"username\": \"jharting@redhat.com\", \"first_name\": \"Jozef\", \"last_name\": \"Hartinger\" }, \"issue_count\": 5, \"system_count\": 12 } ``` + * Optional format for returned data. `\'summary\'` format returns counts instead of issue and system details, e.g.: ``` { \"id\": \"9197ba55-0abc-4028-9bbe-269e530f8bd5\", \"name\": \"Fix Critical CVEs\", \"archived\": true, \"auto_reboot\": true, \"created_at\": \"2018-12-05T08:19:36.641Z\", \"created_by\": { \"username\": \"jharting@redhat.com\", \"first_name\": \"Jozef\", \"last_name\": \"Hartinger\" }, \"updated_at\": \"2018-12-05T08:19:36.641Z\", \"updated_by\": { \"username\": \"jharting@redhat.com\", \"first_name\": \"Jozef\", \"last_name\": \"Hartinger\" }, \"issue_count\": 8, \"issue_count_details\": { \"advisor\": 1, \"ssg\": 1, \"patch-advisory\": 1, \"patch-package\": 1, \"vulnerabilities\": 2, \"test\": 2 }, \"system_count\": 12 } ``` * @type { GetRemediationFormatEnum } * @memberof GetRemediationApi */ diff --git a/packages/remediations/GetRemediationConnectionStatus/index.ts b/packages/remediations/src/GetRemediationConnectionStatus/index.ts similarity index 100% rename from packages/remediations/GetRemediationConnectionStatus/index.ts rename to packages/remediations/src/GetRemediationConnectionStatus/index.ts diff --git a/packages/remediations/GetRemediationIssueSystems/index.ts b/packages/remediations/src/GetRemediationIssueSystems/index.ts similarity index 100% rename from packages/remediations/GetRemediationIssueSystems/index.ts rename to packages/remediations/src/GetRemediationIssueSystems/index.ts diff --git a/packages/remediations/GetRemediationIssues/index.ts b/packages/remediations/src/GetRemediationIssues/index.ts similarity index 100% rename from packages/remediations/GetRemediationIssues/index.ts rename to packages/remediations/src/GetRemediationIssues/index.ts diff --git a/packages/remediations/GetRemediationPlaybook/index.ts b/packages/remediations/src/GetRemediationPlaybook/index.ts similarity index 100% rename from packages/remediations/GetRemediationPlaybook/index.ts rename to packages/remediations/src/GetRemediationPlaybook/index.ts diff --git a/packages/remediations/GetRemediationSystemIssues/index.ts b/packages/remediations/src/GetRemediationSystemIssues/index.ts similarity index 100% rename from packages/remediations/GetRemediationSystemIssues/index.ts rename to packages/remediations/src/GetRemediationSystemIssues/index.ts diff --git a/packages/remediations/GetRemediationSystems/index.ts b/packages/remediations/src/GetRemediationSystems/index.ts similarity index 100% rename from packages/remediations/GetRemediationSystems/index.ts rename to packages/remediations/src/GetRemediationSystems/index.ts diff --git a/packages/remediations/GetRemediations/index.ts b/packages/remediations/src/GetRemediations/index.ts similarity index 89% rename from packages/remediations/GetRemediations/index.ts rename to packages/remediations/src/GetRemediations/index.ts index 07c38d18f..f8498563b 100644 --- a/packages/remediations/GetRemediations/index.ts +++ b/packages/remediations/src/GetRemediations/index.ts @@ -8,7 +8,7 @@ import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/b import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; // @ts-ignore -import type { GetRemediations200Response, GetRemediationsFilterParameter, RequestError } from '../types'; +import type { GetRemediations200Response, GetRemediationsFieldsDataParameter, GetRemediationsFilterParameter, RequestError } from '../types'; export type GetRemediationsParams = { @@ -49,11 +49,11 @@ export type GetRemediationsParams = { */ hideArchived?: boolean, /** - * Include specified items - name: list all remediation plan names in organization (cannot be combined with other fields) - playbook_runs: include playbook run data in the response - * @type { Array } + * Include specified items - name: list all remediation plan names and IDs in organization (cannot be combined with other fields) - playbook_runs: include playbook run data in the response (cannot be combined with other fields) - last_playbook_run: include latest playbook run summary in the response (cannot be combined with other fields) + * @type { GetRemediationsFieldsDataParameter } * @memberof GetRemediationsApi */ - fieldsData?: Array, + fieldsData?: GetRemediationsFieldsDataParameter, options?: AxiosRequestConfig } /** @@ -77,15 +77,6 @@ export const GetRemediationsSortEnum = { NotStatus: '-status' } as const; export type GetRemediationsSortEnum = typeof GetRemediationsSortEnum[keyof typeof GetRemediationsSortEnum]; -/** - * @export - * @enum {string} - */ -export const GetRemediationsFieldsDataEnum = { - Name: 'name', - PlaybookRuns: 'playbook_runs' -} as const; -export type GetRemediationsFieldsDataEnum = typeof GetRemediationsFieldsDataEnum[keyof typeof GetRemediationsFieldsDataEnum]; export type GetRemediationsReturnType = GetRemediations200Response; @@ -103,7 +94,7 @@ const isGetRemediationsObjectParams = (params: [GetRemediationsParams] | unknown * @param {*} [options] Override http request option. * @throws {RequiredError} */ -export const getRemediationsParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([GetRemediationsParams] | [GetRemediationsSortEnum, GetRemediationsFilterParameter, number, number, string, boolean, Array, AxiosRequestConfig])) => { +export const getRemediationsParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([GetRemediationsParams] | [GetRemediationsSortEnum, GetRemediationsFilterParameter, number, number, string, boolean, GetRemediationsFieldsDataParameter, AxiosRequestConfig])) => { const params = isGetRemediationsObjectParams(config) ? config[0] : ['sort', 'filter', 'limit', 'offset', 'system', 'hideArchived', 'fieldsData', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as GetRemediationsParams; const { sort, filter, limit, offset, system, hideArchived, fieldsData, options = {} } = params; const localVarPath = `/remediations`; @@ -137,7 +128,7 @@ export const getRemediationsParamCreator = async (sendRequest: BaseAPI["sendRequ localVarQueryParameter['hide_archived'] = hideArchived; } - if (fieldsData) { + if (fieldsData !== undefined) { localVarQueryParameter['fields[data]'] = fieldsData; } diff --git a/packages/remediations/GetResolutionsForIssue/index.ts b/packages/remediations/src/GetResolutionsForIssue/index.ts similarity index 100% rename from packages/remediations/GetResolutionsForIssue/index.ts rename to packages/remediations/src/GetResolutionsForIssue/index.ts diff --git a/packages/remediations/GetResolutionsForIssues/index.ts b/packages/remediations/src/GetResolutionsForIssues/index.ts similarity index 100% rename from packages/remediations/GetResolutionsForIssues/index.ts rename to packages/remediations/src/GetResolutionsForIssues/index.ts diff --git a/packages/remediations/GetVersion/index.ts b/packages/remediations/src/GetVersion/index.ts similarity index 100% rename from packages/remediations/GetVersion/index.ts rename to packages/remediations/src/GetVersion/index.ts diff --git a/packages/remediations/ListPlaybookRuns/index.ts b/packages/remediations/src/ListPlaybookRuns/index.ts similarity index 100% rename from packages/remediations/ListPlaybookRuns/index.ts rename to packages/remediations/src/ListPlaybookRuns/index.ts diff --git a/packages/remediations/RunRemediation/index.ts b/packages/remediations/src/RunRemediation/index.ts similarity index 100% rename from packages/remediations/RunRemediation/index.ts rename to packages/remediations/src/RunRemediation/index.ts diff --git a/packages/remediations/UpdateRemediation/index.ts b/packages/remediations/src/UpdateRemediation/index.ts similarity index 100% rename from packages/remediations/UpdateRemediation/index.ts rename to packages/remediations/src/UpdateRemediation/index.ts diff --git a/packages/remediations/UpdateRemediationIssue/index.ts b/packages/remediations/src/UpdateRemediationIssue/index.ts similarity index 100% rename from packages/remediations/UpdateRemediationIssue/index.ts rename to packages/remediations/src/UpdateRemediationIssue/index.ts diff --git a/packages/remediations/api.ts b/packages/remediations/src/api.ts similarity index 100% rename from packages/remediations/api.ts rename to packages/remediations/src/api.ts diff --git a/packages/remediations/index.ts b/packages/remediations/src/index.ts similarity index 98% rename from packages/remediations/index.ts rename to packages/remediations/src/index.ts index 9cbabc4dd..db7d416f4 100644 --- a/packages/remediations/index.ts +++ b/packages/remediations/src/index.ts @@ -64,4 +64,3 @@ export { default as updateRemediationIssue, type UpdateRemediationIssueReturnTyp export * from './types' -// Trigger release - updated to regenerate clients diff --git a/packages/remediations/types/index.ts b/packages/remediations/src/types/index.ts similarity index 93% rename from packages/remediations/types/index.ts rename to packages/remediations/src/types/index.ts index 9224fb1af..7adef0a73 100644 --- a/packages/remediations/types/index.ts +++ b/packages/remediations/src/types/index.ts @@ -155,6 +155,12 @@ export interface GetRemediations200Response { */ 'links': Links; } +/** + * @type GetRemediationsFieldsDataParameter + * @export + */ +export type GetRemediationsFieldsDataParameter = Array; + /** * * @export @@ -466,6 +472,12 @@ export interface PlaybookDefinitionIssuesInner { * @memberof PlaybookDefinitionIssuesInner */ 'resolution'?: string; + /** + * Controls the order in which issues are executed in the generated playbook. Lower numbers execute first. If not specified, issues maintain their request order. + * @type {number} + * @memberof PlaybookDefinitionIssuesInner + */ + 'precedence'?: number | null; } /** * @@ -731,7 +743,6 @@ export interface PlaybookRunExecutorDetails { export const PlaybookRunExecutorStatus = { Pending: 'pending', - Acked: 'acked', Running: 'running', Success: 'success', Failure: 'failure', @@ -878,6 +889,12 @@ export interface PlaybookRunSystems { * @memberof PlaybookRunSystems */ 'playbook_run_executor_id': string; + /** + * Executor type for this system (e.g., \'direct\' or \'satellite\') + * @type {string} + * @memberof PlaybookRunSystems + */ + 'executor_type'?: string; } @@ -1017,6 +1034,12 @@ export interface RemediationDetails { * @memberof RemediationDetails */ 'issue_count'?: number; + /** + * Count of issues by type (only included in summary format) + * @type {{ [key: string]: number; }} + * @memberof RemediationDetails + */ + 'issue_count_details'?: { [key: string]: number; }; /** * * @type {number} @@ -1068,13 +1091,13 @@ export interface RemediationInput { */ export interface RemediationInputAdd { /** - * + * Array of issues to add to the remediation. Maximum 50 issues per request. * @type {Array} * @memberof RemediationInputAdd */ 'issues': Array; /** - * + * Default systems that will be applied to all issues that don\'t specify their own systems array. Maximum of 50 unique systems total across all issues per request. * @type {Array} * @memberof RemediationInputAdd */ @@ -1099,11 +1122,17 @@ export interface RemediationInputAddIssuesInner { */ 'resolution'?: string; /** - * + * Systems for this specific issue. If not provided, uses the default systems from the top-level systems array. Maximum of 50 unique systems total across all issues per request. * @type {Array} * @memberof RemediationInputAddIssuesInner */ 'systems'?: Array; + /** + * Controls the order in which issues are executed in the generated playbook. Lower numbers execute first. If not specified, issues are ordered by issue_id. + * @type {number} + * @memberof RemediationInputAddIssuesInner + */ + 'precedence'?: number | null; } /** * @@ -1135,6 +1164,12 @@ export interface RemediationIssue { * @memberof RemediationIssue */ 'resolutions_available'?: number; + /** + * Controls the order in which issues are executed in the generated playbook. Lower numbers execute first. + * @type {number} + * @memberof RemediationIssue + */ + 'precedence'?: number | null; /** * * @type {Array} @@ -1404,6 +1439,12 @@ export interface RemediationNameList { * @interface RemediationNameListItem */ export interface RemediationNameListItem { + /** + * + * @type {string} + * @memberof RemediationNameListItem + */ + 'id': string; /** * * @type {string} @@ -1419,10 +1460,10 @@ export interface RemediationNameListItem { export interface RemediationSystemList { /** * - * @type {Array} + * @type {Array} * @memberof RemediationSystemList */ - 'data': Array; + 'data': Array; /** * * @type {Meta} @@ -1713,6 +1754,37 @@ export interface SystemOut { */ 'resolved'?: boolean; } +/** + * + * @export + * @interface SystemWithIssueCount + */ +export interface SystemWithIssueCount { + /** + * + * @type {string} + * @memberof SystemWithIssueCount + */ + 'id': string; + /** + * + * @type {string} + * @memberof SystemWithIssueCount + */ + 'hostname': string | null; + /** + * + * @type {string} + * @memberof SystemWithIssueCount + */ + 'display_name': string | null; + /** + * Number of issues associated with this system in the remediation plan + * @type {number} + * @memberof SystemWithIssueCount + */ + 'issue_count': number; +} /** * * @export diff --git a/packages/remediations/tsconfig.cjs.json b/packages/remediations/tsconfig.cjs.json index d29a1ef4a..34a67d692 100644 --- a/packages/remediations/tsconfig.cjs.json +++ b/packages/remediations/tsconfig.cjs.json @@ -1,6 +1,21 @@ { "extends": "./tsconfig.esm.json", "compilerOptions": { - "module": "CommonJS", + "declaration": true, + "target": "es5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": ".", + "rootDir": ".", + "lib": [ + "es2017", + "dom" + ] }, + "exclude": [ + "dist", + "node_modules", + "*.d.ts", + "jest.config.ts" + ] } diff --git a/packages/remediations/tsconfig.esm.json b/packages/remediations/tsconfig.esm.json index 28ffe1d28..d3bf25a51 100644 --- a/packages/remediations/tsconfig.esm.json +++ b/packages/remediations/tsconfig.esm.json @@ -1,13 +1,24 @@ { "extends": "./tsconfig.json", "compilerOptions": { - "outDir": "../../dist/out-tsc", + "target": "es2021", + "module": "esnext", + "moduleResolution": "node", "declaration": true, - "types": ["node"], - "module": "ES2015", - "target": "ES5", - "rootDir": "./", + "declarationMap": true, + "noImplicitAny": true, + "outDir": "esm", + "rootDir": ".", + "lib": [ + "es2017", + "dom" + ] }, - "include": ["*.ts", "**/*.ts"], - "exclude": ["jest.config.ts", "dist"] + "include": ["src/**/*.ts"], + "exclude": [ + "dist", + "node_modules", + "*.d.ts", + "jest.config.ts" + ] } diff --git a/packages/remediations/tsconfig.json b/packages/remediations/tsconfig.json index 57cb4c053..de0a8fe35 100644 --- a/packages/remediations/tsconfig.json +++ b/packages/remediations/tsconfig.json @@ -7,7 +7,7 @@ "noImplicitOverride": false, "noPropertyAccessFromIndexSignature": false, "noImplicitReturns": true, - "noFallthroughCasesInSwitch": true, + "noFallthroughCasesInSwitch": true }, "files": [], "references": [